From 1bbe1467d62f7bbe40919fa43c5a892b0462323c Mon Sep 17 00:00:00 2001 From: waltem01 Date: Mon, 12 Feb 2024 11:52:25 +0100 Subject: [PATCH] set main README --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 11e1fb0..d12771f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,17 @@ -## About +# RPI RGB LED Matrix +## 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. + +### 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. + +### 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. + +## 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.