浏览代码

update doc

Nicolas Marcq 8 年之前
父节点
当前提交
867e8697ff
共有 11 个文件被更改,包括 55 次插入27 次删除
  1. 0 0
      Docs/automated_install.md
  2. 4 3
      Docs/brain.md
  3. 6 2
      Docs/default_settings.md
  4. 1 1
      Docs/dev_env_install.md
  5. 1 0
      Docs/neurons.md
  6. 18 0
      Docs/run_jarvis.md
  7. 1 0
      Docs/stt.md
  8. 1 0
      Docs/tts.md
  9. 20 11
      README.md
  10. 0 6
      core/Utils.py
  11. 3 4
      jarvis.py

+ 0 - 0
Docs/automated_install.md


+ 4 - 3
Docs/brain/brain.md → Docs/brain.md

@@ -9,8 +9,8 @@ An input action can be:
 - **an event:** A date or a frequency (E.G: repeat each morning at 8:30)
 
 An output action is
-- a neuron: A module or plugin that will perform some actions like simply talking, run a script, run a command or a complex Ansible playbook.
-- a list of neurons
+- **a neuron:** A module or plugin that will perform some actions like simply talking, run a script, run a command or a complex Ansible playbook.
+- **a list:** of neurons
 
 Brain is expressed in YAML format (see YAML Syntax) and have a minimum of syntax, which intentionally tries to not be a programming language or script, 
 but rather a model of a configuration or a process.
@@ -59,7 +59,7 @@ neurons:
         parameter1: "value1"
         parameter2: "value2"
 ```
-Not here that parameters are indented this one tabulation.
+Not here that parameters are indented with one tabulation bellow the neuron's name.
 
 
 In this example, the neuron called "say" will make Jarvis speak out loud the phrase in parameter **message**.
@@ -77,3 +77,4 @@ In this example, the task is launched when the captured order contains "say hell
 - "i say goodbye you say hello"
 - "whatever I say as long it contains say hello"
 
+To know if your spoken order will be triggered by jarvis, we recommend you to [use the GUI](run_jarvis/md) for testing your STT.

+ 6 - 2
Docs/default_settings.md

@@ -89,7 +89,9 @@ speech_to_text:
   - bing
 ```
 
-Please refer to the STT doc to know available parameter for each supported TTS
+Some arguments are required, some other optional, please refer to the STT documentation to know available parameters for each supported STT.
+
+
 #### text_to_speech
 Text to speech configuration
 Each TTS has it own configuration. This configuration is passed as argument following the syntax bellow
@@ -107,4 +109,6 @@ text_to_speech:
   - voxygen:
       language: "fr"
       voice: "michel"
-```
+```
+
+Some arguments are required, some other optional, please refer to the TTS documentation to know available parameters for each supported TTS.

+ 1 - 1
Docs/dev_env_install.md

@@ -12,7 +12,7 @@ Tested env
 ### Packages installation
 On Ubuntu distribution:
 ```
-sudo apt-get install python-pip python-dev libsmpeg0 libtts-pico-utils sudo apt-get install libsmpeg0 flac
+sudo apt-get install python-pip python-dev libsmpeg0 libtts-pico-utils sudo apt-get install libsmpeg0 flac dialog
 ```
 
 ### Python lib

+ 1 - 0
Docs/neurons.md

@@ -0,0 +1 @@
+# Neurons

+ 18 - 0
Docs/run_jarvis.md

@@ -0,0 +1,18 @@
+# Run JARVIS
+
+
+This is the syntax used to run jarvis from command line
+```
+cd /path/to/jarvis
+python jarvis.py (command)
+```
+
+For example, to start JARVIS we simply use
+```
+python jarvis.py --start
+```
+
+## JARVIS command line
+
+
+

+ 1 - 0
Docs/stt.md

@@ -0,0 +1 @@
+# Speech To Text (STT)

+ 1 - 0
Docs/tts.md

@@ -0,0 +1 @@
+# Text to speech (TTS)

+ 20 - 11
README.md

@@ -5,34 +5,43 @@ JARVIS is voice controlled personal assistant.
 TODO: insert video demo EN
 TODO: insert video demo FR
 
+JARVIS is easy-peasy to use, see the hello world
+```
+  - name: "Hello world"
+    neurons:      
+      - say:
+          message: "Hello world!"
+    when:
+      - order: "say hello"
+```
+
 
 ## Installation
 
-- Automated installation with Ansible 
-- Manual installation for developement
+- [Automated installation](Docs/automated_install.md)
+- [Manual installation for developement](Docs/dev_env_install.md)
 
 ## Usage
 
-- Configure default settings
-- Create the brain of your JARVIS
-- Run JARVIS
+- [Configure default settings](Docs/default_settings.md)
+- [Create the brain of your JARVIS](Docs/brain.md)
+- [Run JARVIS](Docs/run_jarvis.md)
 
 ## Neurons
 
 A neuron is a plugin that can be used from your **brain.yml**. 
 
-- See the list of available neuron.
-- See how to create your own neuron.
-
-
+- See the list of [available neurons](Docs/neurons.md).
+- See how to [create your own neuron](Docs/contributing.md).
 
 
 ## Contributing
 
-If you'd like to contribute to JARVIS, please read our Contributing Guide, which contains the philosophies we want to preserve, tests to run, and more. 
+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.
 
-
+- Contribute
+- Add [issues and feature requests](../../issues)
 
 ## Credits
 

+ 0 - 6
core/Utils.py

@@ -1,6 +0,0 @@
-def my_import(name):
-    components = name.split('.')
-    mod = __import__(components[0])
-    for comp in components[1:]:
-        mod = getattr(mod, comp)
-    return mod

+ 3 - 4
jarvis.py

@@ -19,8 +19,7 @@ def main():
     """
     # create arguments
     parser = argparse.ArgumentParser(description='JARVIS')
-    parser.add_argument("--start", action='store_true', help="Start Jarvis in the current shell")
-    parser.add_argument("--gui", action='store_true', help="Run Jarvis with shell GUI to test components")
+    parser.add_argument("action", help="[start|gui]")
 
     # parse arguments from script parameters
     args = parser.parse_args()
@@ -28,7 +27,7 @@ def main():
         parser.print_usage()
         sys.exit(1)
 
-    if args.start:
+    if args.action == "start":
         print "Starting JARVIS. Press Ctrl+C for stopping"
         # catch signal for killing on Ctrl+C pressed
         signal.signal(signal.SIGINT, signal_handler)
@@ -36,7 +35,7 @@ def main():
         main_controller = MainController()
         main_controller.start()
 
-    if args.gui:
+    if args.action == "gui":
         ShellGui()
 
 if __name__ == '__main__':