mirror of
https://github.com/akuker/RASCSI.git
synced 2024-11-29 16:49:55 +00:00
f96ade9149
* 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>
45 lines
1.3 KiB
Markdown
45 lines
1.3 KiB
Markdown
# RaSCSI OLED Screen
|
|
|
|
## Run as standalone script for development / troubleshooting
|
|
|
|
```bash
|
|
# Make a virtual env named venv
|
|
$ python3 -m venv venv
|
|
# Use that virtual env in this shell
|
|
$ source venv/bin/activate
|
|
# Install requirements
|
|
$ pip3 install -r requirements.txt
|
|
$ PYTHONPATH=$PWD/src:$(dirname $PWD)/common/src python3 src/rascsi_oled_monitor.py
|
|
```
|
|
|
|
### Parameters
|
|
|
|
The script takes two positional parameters:
|
|
* '0' or '180' which decides the screen rotation
|
|
* '32' or '64' which decides the vertical screen resolution in pixels
|
|
|
|
Ex.
|
|
```
|
|
$ 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.
|
|
|
|
## Run the start.sh script standalone
|
|
|
|
The start.sh script can also be run standalone, and will handle the venv creation/updating for you. It takes the same command line parameters in the following format:
|
|
|
|
```
|
|
$ ./start.sh --rotation=180 --height=64
|
|
```
|
|
|
|
## Credits
|
|
### type_writer.ttf
|
|
* _Type Writer_ TrueType font by Mandy Smith
|
|
* Source: https://www.dafont.com/type-writer.font
|
|
* Distributed under BSD 3-Clause by permission from author (see LICENSE for full text)
|
|
|
|
### splash_start_\*.bmp, splash_stop_\*.bmp
|
|
* Drawn by Daniel Markstedt
|
|
* Distributed under BSD 3-Clause by permission from author (see LICENSE for full text)
|