From 3dcd23533545e48b0a2a6fa4dd81f603ed5470e9 Mon Sep 17 00:00:00 2001 From: Abdellah El Morabit Date: Thu, 12 Dec 2024 08:08:46 +0100 Subject: added a preview of the program --- docs/guide.md | 14 +++++++------- preview.png | Bin 0 -> 172353 bytes 2 files changed, 7 insertions(+), 7 deletions(-) create mode 100644 preview.png diff --git a/docs/guide.md b/docs/guide.md index 4cbba50..37dee7c 100644 --- a/docs/guide.md +++ b/docs/guide.md @@ -1,23 +1,23 @@ -------------------------------------------------------------- +--- 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. +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. \ No newline at end of file +Install the executable run it. +![Program Preview](https://github.com/nasrlol/I2C/preview.png) diff --git a/preview.png b/preview.png new file mode 100644 index 0000000..cbe1bd3 Binary files /dev/null and b/preview.png differ -- cgit v1.2.3-70-g09d2