Răsfoiți Sursa

Merge pull request #118 from royto/fix_documentation

fix markdown link and some typos
Monf 8 ani în urmă
părinte
comite
dc34ff538c
6 a modificat fișierele cu 29 adăugiri și 29 ștergeri
  1. 1 1
      Docs/brain.md
  2. 1 1
      Docs/installation/debian_jessie.md
  3. 16 16
      Docs/neuron_list.md
  4. 1 1
      Docs/neurons.md
  5. 5 5
      Docs/stt.md
  6. 5 5
      Docs/tts.md

+ 1 - 1
Docs/brain.md

@@ -1,6 +1,6 @@
 # Brain
 
-The brain is a main component of Kalliope. It's a module that gives a confuguration of your own personal assistant and, so, determines it's behavior and fonctionnalities.
+The brain is a main component of Kalliope. It's a module that gives a configuration of your own personal assistant and, so, determines it's behavior and fonctionnalities.
 
 Brain is composed by synapses: a synapse is the link between input and output actions.
 

+ 1 - 1
Docs/installation/debian_jessie.md

@@ -51,4 +51,4 @@ Then play the recorded audio file
 mplayer test.wav
 ```
 
-If everything is ok, you can start playing with Kalliope. First, take a look to the [default settings](settings.md).
+If everything is ok, you can start playing with Kalliope. First, take a look to the [default settings](../settings.md).

+ 16 - 16
Docs/neuron_list.md

@@ -4,20 +4,20 @@ A neuron is a module that will perform some actions attached to an order. You ca
 
 | Name                                               | Description                                                                             |
 |----------------------------------------------------|-----------------------------------------------------------------------------------------|
-| [ansible_playbook](../neurons/ansible_playbook/)   | Run an ansible playbook                                                                 |
-| [gmail_checker](../neurons/gmail_checker/)         | Get the number of unread email and their subjects from a gmail account                  |
-| [kill_switch](../neurons/kill_switch/)             | Stop Kalliope process                                                                   |
-| [neurotransmitter](../neurons/neurotransmitter/)   | Link synapse together                                                                   |
-| [push_message](../neurons/push_message/)           | Send a push message to a remote device like Android/iOS/Windows Phone or Chrome browser |
-| [rss_reader](../neurons/rss_reader/)               | Get items from a RSS feed                                                               |
-| [say](../neurons/say/)                             | Make Kalliope talk by using TTS                                                         |
-| [script](../neurons/script/)                       | Run an executable script                                                                |
-| [shell](../neurons/shell/)                         | Run a shell command                                                                     |
-| [sleep](../neurons/sleep/)                         | Make Kalliope sleep for a while before continuing                                       |
-| [systemdate](../neurons/systemdate/)               | Give the local system date and time                                                     |
-| [tasker_autoremote](../neurons/tasker_autoremote/) | Send a message to Android tasker app                                                    |
-| [twitter](../neurons/twitter/)                     | Send a Twit from kalliope                                                               |
-| [uri](../neurons/uri/)                             | Interacts with HTTP and HTTPS web services.                                             |
-| [wake_on_lan](../neurons/wake_on_lan/)             | Wake on lan a computer                                                                  |
-| [wikipedia_searcher](../neurons/wikipedia/)        | Search for a page on Wikipedia                                                          |
+| [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 items from a RSS feed                                                               |
+| [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/)        | Search for a page on Wikipedia                                                          |
 

+ 1 - 1
Docs/neurons.md

@@ -115,7 +115,7 @@ set in [settings.yml](settings.yml) file.
 ### Cache
 
 You can override the default cache configuration. By default Kalliope uses a cache to save a generated audio from a TTS engine.
-This cache is usefull to manage sentences that are not suppose to be changed very often. For exemple, the following sentence will not change in time, so it's more optimized to generate it once and to keep it in cash:
+This cache is useful to manage sentences that are not suppose to be changed very often. For example, the following sentence will not change in time, so it's more optimized to generate it once and to keep it in cash:
 ```
 - say:
     message:

+ 5 - 5
Docs/stt.md

@@ -28,11 +28,11 @@ Sometime, an API key will be necessary to use an engine. Click on a TTS engine l
 
 ## Current Available STT
 
-- [apiai](../stt/apiai/README.md)
-- [bing](../stt/bing/README.md)
-- [google](../stt/google/README.md)
-- [houndify](../stt/houndify/README.md)
-- [witai](../stt/wit/README.md)
+- [apiai](../kalliope/stt/apiai/README.md)
+- [bing](../kalliope/stt/bing/README.md)
+- [google](../kalliope/stt/google/README.md)
+- [houndify](../kalliope/stt/houndify/README.md)
+- [witai](../kalliope/stt/wit/README.md)
 
 ## Full Example
 

+ 5 - 5
Docs/tts.md

@@ -51,11 +51,11 @@ generated audio files that will not be played more than once.
 
 ## Current Available TTS
 
-- [acapela](../tts/acapela/README.md)
-- [googletts](../tts/googletts/README.md)
-- [pico2wave](../tts/pico2wave/README.md)
-- [voicerss](../tts/voicerss/README.md)
-- [voxygen](../tts/voxygen/README.md)
+- [acapela](../kalliope/tts/acapela/README.md)
+- [googletts](../kalliope/tts/googletts/README.md)
+- [pico2wave](../kalliope/tts/pico2wave/README.md)
+- [voicerss](../kalliope/tts/voicerss/README.md)
+- [voxygen](../kalliope/tts/voxygen/README.md)
 
 ## Full Example