Updating the README to reflect the new file system layout (#658)

* Updating the README to reflect the new file system layout (and dependencies)

* Compressing two environment variables into a single one

* Adding named arguments

Co-authored-by: Nemanja Lukic <nemanja.lukic@forgerock.com>
This commit is contained in:
n4al 2022-02-12 00:29:48 +00:00 committed by GitHub
parent 5622694701
commit f96ade9149
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -9,7 +9,7 @@ $ python3 -m venv venv
$ source venv/bin/activate
# Install requirements
$ pip3 install -r requirements.txt
$ python3 src/rascsi_oled_monitor.py
$ PYTHONPATH=$PWD/src:$(dirname $PWD)/common/src python3 src/rascsi_oled_monitor.py
```
### Parameters
@ -20,7 +20,7 @@ The script takes two positional parameters:
Ex.
```
$ python3 rascsi_oled_monitor.py 180 64
$ python3 rascsi_oled_monitor.py --rotation 180 --height 64
```
_Note:_ Both parameters must be passed for the script to read them. Ordering is also important.