summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
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
28At the moment the software only supports a CLI version. 28At the moment the software only supports a CLI version.
29 29
30Support wil be kept to Linux and MacOS for now. 30Support wil be kept to Linux and MacOS for now.
31
32---
33
34 I2C CONTROLLER GUIDE
35
36---
37
38This program is designed to control an LCD1602 using python. It supports
39a GUI and CLI interface and is at the moment only linux compatible.
40
41You will need to have a couple of dependency's readdy on your device to use the software.
42
43---
44
45The 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.
46
47The 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.
48
49---
50
51 Installation Guide
52
53Install the executable run it.
54![Program Preview](https://github.com/nasrlol/I2C/preview.png)