linking subdirectories

This commit is contained in:
waltem01 2024-02-12 11:57:06 +01:00
parent 1bbe1467d6
commit 458c9ce995

View File

@ -2,16 +2,16 @@
## Description
This project is a two-part software solution designed to drive LED matrices. It leverages a specific library, which is originally designed for controlling LED matrices. The project adds an additional layer of abstraction to this library, making it more accessible and easier to use.
This project is a two-part software solution designed to drive LED matrices. It leverages a [specific library](./API/deps/librgbmatrix.so), which is originally designed for controlling LED matrices. 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, 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.
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. This server interacts with the REST API, using its commands to execute actions in the form of sub-programs.
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 and the webserver respectively. The setup instructions for each part are provided within their respective directories.
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.