Add requirements.txt and notes on how to setup venv using requirements.txt

pull/2/head
bruegeln 2 years ago
parent 24b64d5224
commit eb81a875f9
  1. 30
      README.md
  2. 4
      requirements.txt

@ -21,6 +21,36 @@ Almost forgot: You'll have to have [pyqt5](https://pypi.org/project/PyQt5/) inst
With these installed we're prep'ed & ready!
## 1.1 Setup
First make sure you have `python3-venv` install! (`sudo apt install python3-venv` on debian/ubuntu based systems)
Now let's create a new virtual environment:
python3 -m venv venv
You should now see a new folder called `venv/`.
Activate the virtual environment with:
source venv/bin/activate
Your shell prompt should now include a hint: *(venv)*
To install the dependencies within this virtual environment:
pip install -r requirements.txt
After you're finished and want to exit the virtual environment call:
deactivate
And to reactive the virtual environment later just calling
source venv/bin/activate
is sufficient.
## 2. Game usage & capabilities ##
There are two options to run the game:

@ -0,0 +1,4 @@
libevdev==0.9
playsound==1.2.2
PyQt5==5.15.2
PyQt5-sip==12.8.1
Loading…
Cancel
Save