Update README, change script format in Pipfile
This commit is contained in:
parent
9a29e94300
commit
53b0b792e1
4
Pipfile
4
Pipfile
|
@ -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"
|
||||
|
|
24
README.md
24
README.md
|
@ -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:
|
||||
|
|
Loading…
Reference in a new issue