Baipyrus/Matrix
1
0
Fork 0
mirror of https://gitlab1.ptb.de/waltem01/Matrix synced 2024-12-25 03:31:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

define prerequisites and dependencies

Browse Source
This commit is contained in:
waltem01 2024-03-15 09:46:30 +01:00
parent 53147db9da
commit 1f55a5d1d4
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
API/README.md
View File

@ -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/).