Matrix/README.md

# RPI RGB LED Matrix

## Description

This project is a two-part software solution designed to drive LED matrices. It leverages a [specific library](./API/deps/librgbmatrix.so), which was originally uploaded by Github user [`hzeller`](https://github.com/hzeller/). The project adds an additional layer of abstraction to this library, making it more accessible and easier to use.

### REST API

The first part of the project is a [REST API](./API/), written in Python. This API interacts with the aforementioned library, providing access to its basic functions as well as more complex commands derived from them.

### Webserver

The second part of the project is a [webserver](./Webserver/). This server interacts with the [REST API](./API/), using its commands to execute actions in the form of sub-programs.

## Project Structure

The project is divided into two main directories, each containing the necessary files for the [REST API](./API/) and the [Webserver](./Webserver/) respectively. You might've noticed the links to these directories whenever they were mentioned. The setup instructions for each part are provided within their respective directories.

## Environment Variables

The project is configured using optional environment variables. You will find project-wide variables here in [`.env.example`](./.env.example) that both the [REST API](./API/) and the [Webserver](./Webserver/) use to configure your hardware configuration.
set main README 2024-02-12 10:52:25 +00:00			`# RPI RGB LED Matrix`
initialize main README 2024-01-11 13:40:23 +00:00
set main README 2024-02-12 10:52:25 +00:00			`## Description`

improve and update documentation 2024-03-15 08:18:35 +00:00			This project is a two-part software solution designed to drive LED matrices. It leverages a [specific library](./API/deps/librgbmatrix.so), which was originally uploaded by Github user [`hzeller`](https://github.com/hzeller/). The project adds an additional layer of abstraction to this library, making it more accessible and easier to use.
set main README 2024-02-12 10:52:25 +00:00
			`### REST API`

linking subdirectories 2024-02-12 10:57:06 +00:00			`The first part of the project is a [REST API](./API/), written in Python. This API interacts with the aforementioned library, providing access to its basic functions as well as more complex commands derived from them.`
set main README 2024-02-12 10:52:25 +00:00
			`### Webserver`

linking subdirectories 2024-02-12 10:57:06 +00:00			`The second part of the project is a [webserver](./Webserver/). This server interacts with the [REST API](./API/), using its commands to execute actions in the form of sub-programs.`
set main README 2024-02-12 10:52:25 +00:00
			`## Project Structure`

improve and update documentation 2024-03-15 08:18:35 +00:00			`The project is divided into two main directories, each containing the necessary files for the [REST API](./API/) and the [Webserver](./Webserver/) respectively. You might've noticed the links to these directories whenever they were mentioned. The setup instructions for each part are provided within their respective directories.`

			`## Environment Variables`

			The project is configured using optional environment variables. You will find project-wide variables here in [`.env.example`](./.env.example) that both the [REST API](./API/) and the [Webserver](./Webserver/) use to configure your hardware configuration.