diff --git a/API/README.md b/API/README.md index 72778b9..c592928 100644 --- a/API/README.md +++ b/API/README.md @@ -4,12 +4,17 @@ This is a REST API to access the Raspberry PI RGB LED Matrix over HTTP. **Note:** This webserver should _never_ be exposed to the outside of the system it's running on, since it's meant to be combined with the provided `SvelteKit` [Webserver](../Webserver/) to serve a GUI. Although it can still be run in standalone (more on this [here](../Webserver/README.md)), please make sure you set up a firewall or other kinds of access rules to **forbid any connections** from outside of this machine (localhost). +## Prerequisites + +1. Install `Raspberry PI OS Lite` using the [official installer](https://www.raspberrypi.com/software/). +2. Make sure you have Python version 3.9.* installed, as the [library](https://github.com/hzeller/rpi-rgb-led-matrix) uses a now deprecated module and as it is the only version proven to work. +3. Install all necessary dependencies shown within this library's [documentation](https://github.com/hzeller/rpi-rgb-led-matrix/blob/master/bindings/python/README.md). + ## Installation -1. Make sure you have Python version 3.9.* installed, as the library uses a now deprecated module and as it is the only version proven to work. -2. Download the main [library](https://github.com/hzeller/rpi-rgb-led-matrix)'s repository and follow the installation [instructions](https://github.com/hzeller/rpi-rgb-led-matrix/blob/master/bindings/python/README.md) for the python binding -3. Download repository with `git clone https://gitlab1.ptb.de/waltem01/Matrix.git` -4. Navigate to the API directory with `cd API/` +1. Download the main [library](https://github.com/hzeller/rpi-rgb-led-matrix)'s repository and follow the installation [instructions](https://github.com/hzeller/rpi-rgb-led-matrix/blob/master/bindings/python/README.md) for the python binding +2. Download repository with `git clone https://gitlab1.ptb.de/waltem01/Matrix.git` +3. Install and copy the following dependencies of the library to this project: **Note:** For further instructions and examples, especially for further development, please refer to the documentation of the [library](https://github.com/hzeller/rpi-rgb-led-matrix/blob/master/bindings/python/samples/).