summaryrefslogtreecommitdiff
path: root/docs/guide.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/guide.md')
-rw-r--r--docs/guide.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/guide.md b/docs/guide.md
new file mode 100644
index 0000000..b248f49
--- /dev/null
+++ b/docs/guide.md
@@ -0,0 +1,13 @@
+-------------------------------------------------------------
+
+ 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.
+
+* sounddevice
+* ...