From 53b0b792e1eac4535a3605f160660e47960787da Mon Sep 17 00:00:00 2001
From: Benedikt Ziemons <ben@rs485.network>
Date: Tue, 30 Jan 2024 15:02:11 +0100
Subject: [PATCH] Update README, change script format in Pipfile

---
 Pipfile   |  4 ++--
 README.md | 24 ++++++++++++++++++++++++
 2 files changed, 26 insertions(+), 2 deletions(-)

diff --git a/Pipfile b/Pipfile
index e22c7dc..fc766d1 100644
--- a/Pipfile
+++ b/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"
diff --git a/README.md b/README.md
index d69f38d..99d5726 100644
--- a/README.md
+++ b/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: