summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAbdellah El Morabit <nsrddyn@gmail.com>2024-11-29 13:24:16 +0100
committerAbdellah El Morabit <nsrddyn@gmail.com>2024-11-29 13:24:16 +0100
commitfdd3b103bb209045123693cd60149b951c7b2be8 (patch)
tree1019543e2db0ec535f9a76c9f8527fa0ef299caa /docs
parent446f3d4742f88b09c85e83e96f6505cd3f6302c5 (diff)
rewritten the source of the application
Diffstat (limited to 'docs')
-rw-r--r--docs/guide.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/guide.md b/docs/guide.md
index b248f49..a874afe 100644
--- a/docs/guide.md
+++ b/docs/guide.md
@@ -11,3 +11,11 @@ You will need to have a couple of dependency's readdy on your device to use the
* sounddevice
* ...
+
+-------------------------------------------------------------
+
+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.
+
+