Update README, change script format in Pipfile

This commit is contained in:
Ben 2024-01-30 15:02:11 +01:00
parent 9a29e94300
commit 53b0b792e1
Signed by: ben
GPG key ID: 1353F41CF1CFF2D3
2 changed files with 26 additions and 2 deletions

View file

@ -15,5 +15,5 @@ nodegraphqt = "*"
python_version = "3.11"
[scripts]
fetch = {call = "factorygame.data.fetch:main()"}
vis = {call = "factorygame.data.vis:main()"}
fetch = "python -m factorygame.data.fetch"
vis = "python -m factorygame.data.vis"

View file

@ -1,11 +1,35 @@
# Satisfactory Plus Calculator
Tool for helping with factory planning.
## Installation
Tested are Python 3.11, PySide2 5.15.11 and Qt 5.15.11. The later two are necessary for the visualisation. Install all Python requirements by using
```sh
pipenv --site-packages sync
```
### Caveats
Only the most recent version of pyside2 is compatible with Python 3.11. Unfortunately the version cannot be found on the Python Package Index and may have to be installed manually and allowing system site-packages in the pipenv.
For this, run the following before any virtual environment exists (or remove the existing virtual environment using `pipenv --rm`):
```sh
pipenv --site-packages sync
```
## Fetch Recipes
Using pipenv, run e.g.
```sh
pipenv run fetch --result 'Molten Iron'
```
## Visualisation
Thanks to [NodeGraphQt](https://github.com/jchanvfx/NodeGraphQt) a graph base visualisation is available, which looks like the following: