Modified the folder structure to the correct form

software-students-spring2024 · Mar 26, 2024 · 6dc98e7 · 6dc98e7
1 parent a6bdcdd
commit 6dc98e7
Show file tree

Hide file tree

Showing 19 changed files with 60 additions and 1,345 deletions.
diff --git a/LICENSE b/LICENSE
diff --git a/Pipfile b/Pipfile
@@ -1,14 +1,22 @@
-[[source]]
+[[
+source
+]]
 url = "https://pypi.org/simple"
 verify_ssl = true
 name = "pypi"
 
-[packages]
+[
+packages
+]
+
+[
+dev-packages
+]
 pytest = "*"
-twine = "*"
 build = "*"
+twine = "*"
 
-[dev-packages]
-
-[requires]
-python_version = "3.12"
+[
+requires
+]
+python_version = "3.8"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -1,3 +1,25 @@
-# Python Package Exercise
+# New York Minute
 
-An exercise to create a Python package, build it, test it, distribute it, and use it. See [instructions](./instructions.md) for details.
+New York Minute is a text-based game set in New York City. As a player, you choose your background and dream, and navigate through different locations in the city while making decisions to work, relax, network, and save your progress. The goal is to achieve your dream by gaining reputation points.
+
+## Installation
+
+You can install New York Minute using pip:
+
+pip install new-york-minute
+
+## Usage
+
+To start the game, run the following command:
+
+python -m new_york_minute
+
+Follow the prompts to create a new player or load a previous game. Make choices during each turn to work, relax, network, or save your progress. The game ends when you achieve your dream or complete all the locations.
+
+## Contributing
+
+Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on the [GitHub repository](https://github.com/software-students-spring2024/3-python-package-exercise-namelessss).
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
diff --git a/src/new_york_minute/_init_.py → new_york_minute/_init_.py b/src/new_york_minute/_init_.py → new_york_minute/_init_.py
diff --git a/src/new_york_minute/events.py → new_york_minute/events.py b/src/new_york_minute/events.py → new_york_minute/events.py
diff --git a/src/new_york_minute/game.py → new_york_minute/game.py b/src/new_york_minute/game.py → new_york_minute/game.py
diff --git a/src/new_york_minute/player.py → new_york_minute/player.py b/src/new_york_minute/player.py → new_york_minute/player.py
diff --git a/src/new_york_minute/utils.py → new_york_minute/utils.py b/src/new_york_minute/utils.py → new_york_minute/utils.py
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/requirements.txt b/requirements.txt
diff --git a/src/setup.py → setup.py b/src/setup.py → setup.py
diff --git a/src/.github/workflows/python-package.yml b/src/.github/workflows/python-package.yml
diff --git a/src/.gitignore b/src/.gitignore
diff --git a/src/LICENSE b/src/LICENSE
diff --git a/src/Pipfile b/src/Pipfile
diff --git a/src/readme.md b/src/readme.md
diff --git a/src/tests/_init_.py → tests/_init_.py b/src/tests/_init_.py → tests/_init_.py
diff --git a/src/tests/test_new_york_minute.py → tests/test_new_york_minute.py b/src/tests/test_new_york_minute.py → tests/test_new_york_minute.py