瀏覽代碼

update doc

Nicolas Marcq 8 年之前
父節點
當前提交
af3a67a7df
共有 2 個文件被更改,包括 61 次插入7 次删除
  1. 56 4
      Docs/jarvis_cli.md
  2. 5 3
      README.md

+ 56 - 4
Docs/jarvis_cli.md

@@ -1,6 +1,6 @@
-# JARVIS CLI
-
+# JARVIS Command-line interface
 
+## SYNOPSIS
 This is the syntax used to run jarvis from command line
 ```
 cd /path/to/jarvis
@@ -12,10 +12,62 @@ For example, to start JARVIS we simply use
 python jarvis.py start
 ```
 
-## JARVIS command lines
+## ARGUMENTS
 
 ### start
-This command 
+Start jarvis main program
+
+Example usage
+```
+python jarvis.py start
+```
+
+To kill jarvis, you can press "Ctrl-C" on your keyboard.
+
+### gui
+Launch the jarvis shell Graphical User Interface. 
+The GUI allow you to test your [STT](stt.md) and [TTS](tts.md) that you have configured in [settings.yml](default_settings.md) file of JARVIS.
+
+Example usage
+```
+python jarvis.py gui
+```
+
+### load-events
+Load crontab file with synapses from the brain which they have an event attached as inout signal.
+
+Example usage
+```
+python jarvis.py load-events
+```
+
+## OPTIONS
+
+### --run-synapse SYNAPSE_NAME
+
+Run a specific synapse from the brain file.
+
+Example usage
+```
+python jarvis.py start --run-synapse "say hello"
+```
 
+### --brain-file BRAIN_FILE
 
+To use another brain file than the default one from the root of the project folder.
+> **Important note:** The path must be absolute. The absolute path contains the root directory and all other subdirectories in which a file or folder is contained. 
 
+Example usage
+```
+python jarvis.py start --brain-file /home/me/my_other_brain.yml
+python jarvis.py start --run-synapse "say hello" --brain-file /home/me/my_other_brain.yml
+```
+
+### --debug
+
+Show debug output in the console
+
+Example usage
+```
+python jarvis.py start --debug
+```

+ 5 - 3
README.md

@@ -1,10 +1,12 @@
 # Jarvis
 
-JARVIS is voice controlled personal assistant. 
+JARVIS is a modular always-on voice controlled personal assistant designed for home automation.
 
 TODO: insert video demo EN
 TODO: insert video demo FR
 
+JARVIS can run on a Raspberry Pi and he's multi-lang.
+
 JARVIS is easy-peasy to use, see the hello world
 ```
   - name: "Hello world"
@@ -37,8 +39,8 @@ A neuron is a plugin that can be used from your **brain.yml**.
 
 ## Contributing
 
-If you'd like to contribute to JARVIS, please read our [Contributing Guide](Docs/contributing.md), which contains the philosophies we want to preserve, tests to run, and more. 
-We highly recommend reading through this guide before writing any code.
+If you'd like to contribute to JARVIS, please read our [Contributing Guide](Docs/contributing.md), which contains the philosophies to preserve, tests to run, and more. 
+Reading through this guide before writing any code is recommended.
 
 - Contribute
 - Add [issues and feature requests](../../issues)