diff options
| -rw-r--r-- | README.md | 24 | ||||
| -rw-r--r-- | docs/guide.md | 23 |
2 files changed, 24 insertions, 23 deletions
@@ -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. + diff --git a/docs/guide.md b/docs/guide.md deleted file mode 100644 index 37dee7c..0000000 --- a/docs/guide.md +++ /dev/null @@ -1,23 +0,0 @@ ---- - - 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. - |