Add dev instructions
This commit is contained in:
15
README.md
15
README.md
@@ -4,8 +4,19 @@ A procedural city generator for Minecraft as part of the GDMC 2024 competition.
|
||||
# Run
|
||||
|
||||
Install required packages using `pip`:
|
||||
```python
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
Run `main.py`.
|
||||
Run `main.py`.
|
||||
|
||||
# Dev
|
||||
|
||||
First, setup your virtual environment using Python's built-in venv.
|
||||
|
||||
Install `pipreqs`:
|
||||
```bash
|
||||
pip install pipreqs
|
||||
```
|
||||
|
||||
Run `pipreqs --ignore .venv` to generate an updated list of dependencies for the project in requirements file.
|
||||
Reference in New Issue
Block a user