Skip to content

Commit

Permalink
Update the readme
Browse files Browse the repository at this point in the history
Installing as previously instructed would error out because
setuptools-scm requires git metadata.
  • Loading branch information
mitaa committed Sep 20, 2024
1 parent fc8b774 commit 6a0bc39
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
auxiliary/
*.html
*.stackdump
.staging
.*

# Byte-compiled / optimized / DLL files
__pycache__/
Expand Down Expand Up @@ -29,6 +31,7 @@ share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
*.whl
MANIFEST

# PyInstaller
Expand Down
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,16 @@ Make sure that python has been added to the *PATH* environment variable (tick th

And run the `install.bat` file

Or open the terminal (e.g. PowerShell), cd into the folder, and install it.
Or open the terminal (e.g. PowerShell) and run the following command

```
cd .\production_planner-master\
pip install .
pip install git+https://github.com/mitaa/production_planner.git#egg=production_planner
```

## Usage
Run the `run.bat` file

Or open the terminal (the current directory doesn't matter as long as python has been added to *PATH*)\
And then run
Or open the terminal and run

```
production_planner
Expand Down
2 changes: 1 addition & 1 deletion install.bat
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
pip install .
pip install git+https://github.com/mitaa/production_planner.git#egg=production_planner
pause

0 comments on commit 6a0bc39

Please sign in to comment.