Browse Source

update doc

Nicolas Marcq 8 years ago
parent
commit
6495488957
4 changed files with 19 additions and 4 deletions
  1. 2 2
      Docs/brain.md
  2. 15 0
      Docs/neuron_list.md
  3. 1 1
      Docs/neurons.md
  4. 1 1
      Docs/signals.md

+ 2 - 2
Docs/brain.md

@@ -4,12 +4,12 @@ The brain is where you create your personal assistant, your own configuration.
 
 Brain is composed by synapses, a synapse is the link between input and output actions.
 
-A input action, called a "signal" can be:
+A input action, called a "[signal](signals.md)" can be:
 - **an order:** Something that has been spoke out loud by the user.
 - **an event:** A date or a frequency (E.G: repeat each morning at 8:30)
 
 An output action is
-- **a list of neurons:** 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](neurons.md) is a module or plugin that will perform some actions like simply talking, run a script, run a command or a complex Ansible playbook.
 
 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.

+ 15 - 0
Docs/neuron_list.md

@@ -0,0 +1,15 @@
+# List of available neuron
+
+
+| Name                                                | Description                                                                             |
+|-----------------------------------------------------|-----------------------------------------------------------------------------------------|
+| [ansible_task](../neurons/ansible_task/README.md)   | Run an ansible playbook                                                                 |
+| [command](../neurons/command/README.md)             | Run a shell command                                                                     |
+| [gmail_checker](../neurons/gmail_checker/README.md) | Get the number of unread email and their subjects from a gmail account                  |
+| [kill_switch](../neurons/kill_switch/README.md)     | Stop Jarvis process                                                                     |
+| [push_message](../neurons/push_message/README.md)   | Send a push message to a remote device like Android/iOS/Windows Phone or Chrome browser |
+| [say](../neurons/say/README.md)                     | Make Jarvis talk by using TTS                                                           |
+| [script](../neurons/script/README.md)               | Run an executable script                                                                |
+| [sleep](../neurons/sleep/README.md)                 | Make Jarvis sleep for a while before continuing                                         |
+| [systemdate](../neurons/systemdate/README.md)       | Give the local system date and time                                                     |
+

+ 1 - 1
Docs/neurons.md

@@ -23,5 +23,5 @@ neurons:
 
 To know which parameter are required, check of documentation of the neuron.
 
-## List of available neuron
+Full list of [available neuron here](neuron_list.md)
 

+ 1 - 1
Docs/signals.md

@@ -69,7 +69,7 @@ For example, if we want Kalliope to run the synapse every day a 8 PM. The event
 
 Let make a complete example. We want Kalliope to wake us up each morning of working day (Monday to friday) at 7 AM and:
 - Wish us good morning
-- Give us the our
+- Give us the time
 - Play our favourite web radio
 
 The synapse in the brain would be