Browse Source

doc update

nico 8 years ago
parent
commit
63dacf5520
4 changed files with 70 additions and 18 deletions
  1. 28 18
      Docs/neuron_list.md
  2. 5 0
      Docs/neuron_template.md
  3. 18 0
      Docs/neurons.md
  4. 19 0
      Docs/settings.md

+ 28 - 18
Docs/neuron_list.md

@@ -2,22 +2,32 @@
 
 A neuron is a module that will perform some actions attached to an order. You can use it in your synapses. See the [complete neuron documentation](neurons.md) for more information.
 
-| Name                                                          | Description                                                                             |
-|---------------------------------------------------------------|-----------------------------------------------------------------------------------------|
-| [ansible_playbook](../kalliope/neurons/ansible_playbook/)     | Run an ansible playbook                                                                 |
-| [gmail_checker](../kalliope/neurons/gmail_checker/)           | Get the number of unread email and their subjects from a gmail account                  |
-| [kill_switch](../kalliope/neurons/kill_switch/)               | Stop Kalliope process                                                                   |
-| [neurotransmitter](../kalliope/neurons/neurotransmitter/)     | Link synapse together                                                                   |
-| [push_message](../kalliope/neurons/push_message/)             | Send a push message to a remote device like Android/iOS/Windows Phone or Chrome browser |
-| [rss_reader](../kalliope/neurons/rss_reader/)                 | get rss feed from website                                                               |
-| [say](../kalliope/neurons/say/)                               | Make Kalliope talk by using TTS                                                         |
-| [script](../kalliope/neurons/script/)                         | Run an executable script                                                                |
-| [shell](../kalliope/neurons/shell/)                           | Run a shell command                                                                     |
-| [sleep](../kalliope/neurons/sleep/)                           | Make Kalliope sleep for a while before continuing                                       |
-| [systemdate](../kalliope/neurons/systemdate/)                 | Give the local system date and time                                                     |
-| [tasker_autoremote](../kalliope/neurons/tasker_autoremote/)   | Send a message to Android tasker app                                                    |
-| [twitter](../kalliope/neurons/twitter/)                       | Send a Twit from kalliope                                                               |
-| [uri](../kalliope/neurons/uri/)                               | Interacts with HTTP and HTTPS web services.                                             |
-| [wake_on_lan](../kalliope/neurons/wake_on_lan/)               | Wake on lan a computer                                                                  |
-| [wikipedia_searcher](../kalliope/neurons/wikipedia_searcher/) | Search for a page on Wikipedia                                                          |
+## Core neuron
 
+| Name                                                      | Description                                       |
+|-----------------------------------------------------------|---------------------------------------------------|
+| [ansible_playbook](../kalliope/neurons/ansible_playbook/) | Run an ansible playbook                           |
+| [kill_switch](../kalliope/neurons/kill_switch/)           | Stop Kalliope process                             |
+| [neurotransmitter](../kalliope/neurons/neurotransmitter/) | Link synapse together                             |
+| [say](../kalliope/neurons/say/)                           | Make Kalliope talk by using TTS                   |
+| [script](../kalliope/neurons/script/)                     | Run an executable script                          |
+| [shell](../kalliope/neurons/shell/)                       | Run a shell command                               |
+| [sleep](../kalliope/neurons/sleep/)                       | Make Kalliope sleep for a while before continuing |
+| [systemdate](../kalliope/neurons/systemdate/)             | Give the local system date and time               |
+| [uri](../kalliope/neurons/uri/)                           | Interacts with HTTP and HTTPS web services.       |
+
+## Community neuron
+
+| Name                                                                           | Description                                                                             |
+|--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------|
+| [gmail_checker](https://github.com/kalliope-project/kalliope_neuron_gmail)     | Get the number of unread email and their subjects from a gmail account                  |
+| [pushetta](https://github.com/kalliope-project/kalliope_neuron_pushetta)       | Send a push message to a remote device like Android/iOS/Windows Phone or Chrome browser |
+| [rss_reader](https://github.com/kalliope-project/kalliope_neuron_rss_reader)   | get rss feed from website                                                               |
+| [tasker](https://github.com/kalliope-project/kalliope_neuron_tasker)           | Send a message to Android tasker app                                                    |
+| [twitter](https://github.com/kalliope-project/kalliope_neuron_twitter)         | Send a Twit from kalliope                                                               |
+| [wake_on_lan](https://github.com/kalliope-project/kalliope_neuron_wake_on_lan) | Wake on lan a computer                                                                  |
+| [wikipedia](https://github.com/kalliope-project/kalliope_neuron_wikipedia)     | Search for a page on Wikipedia                                                          |
+
+Wanna add your neuron in the list? Open [an issue](../../issues) with the link of your neuron or send a pull request to update the list directly.
+
+To know how to install a community neuron, read the "Installation" section of the [neuron documentation](neurons.md).

+ 5 - 0
Docs/neuron_template.md

@@ -4,6 +4,11 @@
 
 Little description of what the neuron does.
 
+Installation
+```
+kalliope neuron-install --git-url "https://github.com/my_user/my_neuron.git"
+```
+
 ## Options
 
 (usage of a [table generator](http://www.tablesgenerator.com/markdown_tables) is recommended)

+ 18 - 0
Docs/neurons.md

@@ -3,6 +3,22 @@
 A neuron is a plugin that performs a specific action. You use it to create a synapse.
 You can add as many neurons as you want to a synapse. The neurons are executed one by one when the input order is triggered.
 
+## Installation
+
+Core neurons are already packaged with the installation of kalliope an can be used out of the box. Community neuron need to be installed manually.
+
+Use the CLI
+```
+kalliope neuron-install --git-url "<git_url>"
+```
+
+E.g:
+```
+kalliope neuron-install --git-url "https://github.com/kalliope-project/kalliope_neuron_wikipedia.git"
+```
+
+You may be prompted to type your `sudo` password during the process. You can see the list of [available neuron here](neuron_list.md)
+
 ## Usage
 Neurons are declared in the `neurons` section of a synapse in your brain file.
 The `neurons` section is a list (because it starts with a "-") which contains neuron modules names
@@ -22,6 +38,8 @@ neurons:
 ```
 > **note:** parameters are indented with two spaces bellow the neuron's name following the YAML syntax.
 
+> **note:** Kalliope will try to load the neuron from your resources directory, then from core neuron packages.
+
 To know the list of required parameters, check of documentation of the neuron.
 Full list of [available neuron here](neuron_list.md)
 

+ 19 - 0
Docs/settings.md

@@ -225,5 +225,24 @@ E.g
 default_synapse: "Default-response"
 ```
 
+## Resources directory
+
+The resources directory is the path where Kalliope will try to load community modules like Neurons, STTs or TTSs.
+Set a valid path is required if you want to install community neuron. The path can be relative or absolute.
+
+```
+resource_directory:
+  resource_name: "path"
+```
+
+E.g
+```
+resource_directory:
+  neuron: "resources/neurons"
+  stt: "resources/stt"
+  tts: "resources/tts"
+  trigger: "/full/path/to/trigger"
+```
+
 ## Next: configure the brain of Kalliope
 Now your settings are ok, you can start creating the [brain](brain.md) of your assistant.