From cf4b2ea56bef6ddc2dbdb30f14b104f49d12ae5e Mon Sep 17 00:00:00 2001 From: Abdellah El Morabit Date: Thu, 12 Dec 2024 08:19:30 +0100 Subject: removed the guide md and moved everything to the md, it zas one uneccesary file too much --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 35429b4..02c3a58 100644 --- a/README.md +++ b/README.md @@ -28,3 +28,27 @@ A nice idea is to make it somehting easily installable and configurable in the f At the moment the software only supports a CLI version. Support wil be kept to Linux and MacOS for now. + +--- + + I2C CONTROLLER GUIDE + +--- + +This program is designed to control an LCD1602 using python. It supports +a GUI and CLI interface and is at the moment only linux compatible. + +You will need to have a couple of dependency's readdy on your device to use the software. + +--- + +The software supports multiple fetures ranging from a note saving system ( which is actually a fun way of saying displaying something on the screen and saving the output for later use) to speech transription and system readings. + +The main way of using the software is the CLI. run the main.py file and you will see the options pop, after running them they will run automaticly, the CLI is still the recomended way of using it simply because it's ment for controlling an RPI through an SSH session. + +--- + + Installation Guide + +Install the executable run it. +![Program Preview](https://github.com/nasrlol/I2C/preview.png) -- cgit v1.2.3-70-g09d2