Browse Source

[Doc] Review of Doc update

monf 8 years ago
parent
commit
e420359c96

+ 2 - 2
Docs/brain.md

@@ -13,7 +13,7 @@ An output action is
 
 Brain is expressed in YAML format (see YAML Syntax) and has 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.
-Kalliope will search her brain in the order bellow:
+Kalliope will look for the brain in the order bellow:
 - From you current folder, E.g `/home/pi/my_kalliope/brain.yml`
 - From `/etc/kalliope/brain.yml`
 - From the default `brain.yml`. You can take a look into the default [`brain.yml`](../kalliope/brain.yml) file which is located in the root of the project tree.
@@ -132,6 +132,6 @@ You can provide a default synapse in case none of them are matching when an orde
 >**Note:** You need to define it in the settings.yml cf :[Setting](settings.md).
 
 ## Next: Start Kalliope
-Now you take a look into the [CLI documentation](kalliope_cli.md) to learn how to start kalliope
+Now you take a look into the [CLI documentation](kalliope_cli.md) to learn how to start kalliope.
 
 

+ 3 - 3
Docs/installation.md

@@ -2,7 +2,7 @@
 
 ## Prerequisites
 
-Please follow link bellow to install requirements depending on your target environment:
+Please follow the right link bellow to install requirements depending on your target environment:
 - [Raspbian (Raspberry Pi 2 & 3)](installation/raspbian_jessie.md)
 - [Ubuntu 14.04/16.04](installation/ubuntu_16.04.md)
 - [Debian Jessie](installation/debian_jessie.md)
@@ -79,7 +79,7 @@ Then play the recorded audio file
 mplayer test.wav
 ```
 
-You can then test your Kalliope is working by using the "bonjour" order integrated in the [default brain](../kalliope/brain.yml).
+You can then test that your Kalliope is working by using the "bonjour" order integrated in the [default brain](../kalliope/brain.yml).
 Start kalliope:
 ```
 kalliope start
@@ -111,7 +111,7 @@ Waiting for trigger detection
 
 ## Get a starter configuration
 We create some starter configuration that only need to be downloaded and then started. 
-Those repositories provides you a basic structure to start playing with kalliope. We recommend you to clone one of them and then go to the next section.
+Those repositories provide you a basic structure to start playing with kalliope. We recommend you to clone one of them and then go to the next section.
 
 - [French starter config](https://github.com/kalliope-project/kalliope_starter_fr)
 - [English starter config](https://github.com/kalliope-project/kalliope_starter_en)

+ 1 - 3
Docs/installation/debian_jessie.md

@@ -2,12 +2,10 @@
 
 ## Debian packages requirements
 
-Edit `/etc/apt/sources.list` and check that you have `contrib` and `non-free` and backports archives enabled:
+Edit `/etc/apt/sources.list` and check that you have `contrib` and `non-free` are enabled:
 ```
 deb http://httpredir.debian.org/debian jessie main contrib non-free
 deb-src http://httpredir.debian.org/debian jessie main contrib non-free
-deb http://httpredir.debian.org/debian jessie-backports main contrib non-free
-deb-src http://httpredir.debian.org/debian jessie-backports main contrib non-free
 ```
 
 Install some required system libraries and softwares:

+ 1 - 1
Docs/installation/raspbian_jessie.md

@@ -11,7 +11,7 @@ sudo apt-get install git python-pip python-dev libsmpeg0 libttspico-utils libsmp
 
 ## Raspberry Pi configuration
 
-This part deals with the special configuration needed for get kalliope working on a RPi.
+This part deals with the special configuration needed to get kalliope working on a RPi.
 
 ### Packages
 

+ 1 - 1
Docs/neurons.md

@@ -66,7 +66,7 @@ the [template engine](https://en.wikipedia.org/wiki/Jinja_(template_engine)), an
 
 The template engine used in Kalliope is [Jinja2](http://jinja.pocoo.org/docs/dev/).
 
-For example, if we look at the [documentation of the neuron systemedate](../kalliope/neurons/systemdate), we can see that the neuron will return a dictionary of value like `minute`, `hours` and all other values about the current time on the system where Kalliope is installed.
+For example, if we look at the [documentation of the neuron systemedate](../kalliope/neurons/systemdate/README.md), we can see that the neuron will return a dictionary of value like `minute`, `hours` and all other values about the current time on the system where Kalliope is installed.
 
 A simple, that only use **variables**, template would be
 ```

+ 2 - 2
Docs/settings.md

@@ -2,7 +2,7 @@
 
 This part of the documentation explains the main configuration of Kalliope.
 
-Kalliope need two file to works, a `settings.yml` and a `brain.yml`. Files are written on YAML syntax.
+Kalliope needs two files to works, a `settings.yml` and a `brain.yml`. Files are written on YAML syntax.
 
 When you start kalliope using the CLI, the program will try to load your settings.yml and brain.yml in the following order:
 - From you current folder, E.g `/home/pi/my_kalliope/settings.yml`
@@ -226,4 +226,4 @@ default_synapse: "Default-response"
 ```
 
 ## Next: configure the brain of Kalliope
-Now your settings are ok, you can start creating the [brain](brain.md) of your assistant.
+Now your settings are ok, you can start creating the [brain](brain.md) of your assistant.

+ 2 - 2
Docs/trigger.md

@@ -8,7 +8,7 @@ With Kalliope project, you can set whatever Hotword you want to wake it up.
 You can create your magic word by connecting to [Snowboy](https://snowboy.kitt.ai/) and then download the trained model file.
 
 Once downloaded:
-- place the file in your config folder.
+- place the file in your personal config folder.
 - update the path of **pmdl_file** in [your settings](settings.md).
 
 If you want to keep "Kalliope" as the name of your bot, we recommend you to enhance the existing Snowboy model for your language.
@@ -30,4 +30,4 @@ Then, open an issue or create a pull request to add the model to the list bellow
 | Name                                                | language |
 |-----------------------------------------------------|----------|
 | [kalliope-FR](https://snowboy.kitt.ai/hotword/1363) | French   |
-| [kalliope-EN](https://snowboy.kitt.ai/hotword/2540) | English  |
+| [kalliope-EN](https://snowboy.kitt.ai/hotword/2540) | English  |