Browse Source

update doc

nico 8 years ago
parent
commit
50230e4830

+ 2 - 0
Docs/installation.md

@@ -86,6 +86,8 @@ Start kalliope:
 kalliope start
 kalliope start
 ```
 ```
 
 
+> **Note:** Do not start Kalliope as root user or with sudo
+
 Kalliope will load default settings and brain, the output should looks the following
 Kalliope will load default settings and brain, the output should looks the following
 ```bash
 ```bash
 Starting event manager
 Starting event manager

+ 3 - 0
Docs/installation/raspbian_jessie.md

@@ -7,6 +7,9 @@
 [raspbian-2016-11-29](http://downloads.raspberrypi.org/raspbian/images/raspbian-2016-11-29/)
 [raspbian-2016-11-29](http://downloads.raspberrypi.org/raspbian/images/raspbian-2016-11-29/)
 [raspbian-2017-01-10](http://downloads.raspberrypi.org/raspbian/images/raspbian-2017-01-10/)
 [raspbian-2017-01-10](http://downloads.raspberrypi.org/raspbian/images/raspbian-2017-01-10/)
 
 
+> **Note:** We recommend to use a **lite** installation of Raspbian without any graphical interface for a better experience. 
+
+> **Note:** The first Raspberry Pi is not officially supported. The installation will works but a single core with only 700Mhz may produce a some latencies.
 
 
 ## Debian packages requirements
 ## Debian packages requirements
 
 

+ 7 - 1
Docs/installation/ubuntu_14.04.md

@@ -6,5 +6,11 @@ Install some required system libraries and softwares:
 
 
 ```bash
 ```bash
 sudo apt-get update
 sudo apt-get update
-sudo apt-get install git python-pip python-dev libsmpeg0 libttspico-utils libsmpeg0 flac dialog libffi-dev libffi-dev libssl-dev libjack0 libjack-dev portaudio19-dev build-essential libssl-dev libffi-dev sox libatlas3-base mplayer
+sudo apt-get install git python-dev libsmpeg0 libttspico-utils libsmpeg0 flac dialog libffi-dev libffi-dev libssl-dev libjack0 libjack-dev portaudio19-dev build-essential libssl-dev libffi-dev sox libatlas3-base mplayer
+```
+
+Let's install the last release of python-pip
+```bash
+wget https://bootstrap.pypa.io/get-pip.py
+sudo python get-pip.py
 ```
 ```

+ 6 - 1
Docs/installation/ubuntu_16.04.md

@@ -6,5 +6,10 @@ Install some required system libraries and softwares:
 
 
 ```bash
 ```bash
 sudo apt-get update
 sudo apt-get update
-sudo apt-get install git python-pip python-dev libsmpeg0 libttspico-utils libsmpeg0 flac dialog libffi-dev libffi-dev libssl-dev portaudio19-dev build-essential libssl-dev libffi-dev sox libatlas3-base mplayer
+sudo apt-get install git python-dev libsmpeg0 libttspico-utils libsmpeg0 flac dialog libffi-dev libffi-dev libssl-dev portaudio19-dev build-essential libssl-dev libffi-dev sox libatlas3-base mplayer
+```
+Let's install the last release of python-pip
+```bash
+wget https://bootstrap.pypa.io/get-pip.py
+sudo python get-pip.py
 ```
 ```

+ 2 - 0
Docs/kalliope_cli.md

@@ -11,6 +11,8 @@ For example, to start Kalliope we simply use
 kalliope start
 kalliope start
 ```
 ```
 
 
+> **Note:** Do not use the CLI as root user or with sudo. Kalliope must run with standard user privileges.
+
 ## ARGUMENTS
 ## ARGUMENTS
 
 
 ### start
 ### start

+ 2 - 8
Docs/stt.md

@@ -26,14 +26,8 @@ speech_to_text:
 Sometime, an API key will be necessary to use an engine. Click on a TTS engine link in the `Current Available STT` section to know which parameter are required.
 Sometime, an API key will be necessary to use an engine. Click on a TTS engine link in the `Current Available STT` section to know which parameter are required.
 
 
 ## Current CORE Available STT
 ## Current CORE Available STT
-Core STTs are already packaged with the installation of Kalliope an can be used out of the box.
-
-- [apiai](../kalliope/stt/apiai/README.md)
-- [bing](../kalliope/stt/bing/README.md)
-- [CMUSphinx](../kalliope/stt/cmusphinx/README.md)
-- [google](../kalliope/stt/google/README.md)
-- [houndify](../kalliope/stt/houndify/README.md)
-- [witai](../kalliope/stt/wit/README.md)
+
+Core STTs are already packaged with the installation of Kalliope an can be used out of the box. See the [complete list here](stt_list.md).
 
 
 ## STT Community Installation
 ## STT Community Installation
 
 

+ 8 - 11
Docs/stt_list.md

@@ -6,14 +6,14 @@ See the [complete STT documentation](stt.md) for more information.
 ## Core STT
 ## Core STT
 Core STTs are already packaged with the installation of Kalliope an can be used out of the box.
 Core STTs are already packaged with the installation of Kalliope an can be used out of the box.
 
 
-| Name      | Description                                      |
-|-----------|--------------------------------------------------|
-| api.ai    | [apiai](../kalliope/stt/apiai/README.md)         |
-| bing      | [bing](../kalliope/stt/bing/README.md)           |
-| Google    | [google](../kalliope/stt/google/README.md)       |
-| Houndify  | [houndify](../kalliope/stt/houndify/README.md)   |
-| CMUSphinx | [CMUSphinx](../kalliope/stt/cmusphinx/README.md) |
-| wit.ai    | [wit.ai](../kalliope/stt/wit/README.md)          |
+| Name      | Description                                      | Type        |
+|-----------|--------------------------------------------------|-------------|
+| api.ai    | [apiai](../kalliope/stt/apiai/README.md)         | Cloud based |
+| bing      | [bing](../kalliope/stt/bing/README.md)           | Cloud based |
+| CMUSphinx | [CMUSphinx](../kalliope/stt/cmusphinx/README.md) | Self hosted |
+| Google    | [google](../kalliope/stt/google/README.md)       | Cloud based |
+| Houndify  | [houndify](../kalliope/stt/houndify/README.md)   | Cloud based |
+| wit.ai    | [wit.ai](../kalliope/stt/wit/README.md)          | Cloud based |
 
 
 
 
 ## Community STT
 ## Community STT
@@ -21,9 +21,6 @@ Community STTs need to be installed manually.
 
 
 To know how to install a community STT, read the "Installation" section of the [STT documentation](stt.md).
 To know how to install a community STT, read the "Installation" section of the [STT documentation](stt.md).
 
 
-| Name     | Description                                    |
-|----------|------------------------------------------------|
-
 Wanna add your STT in the list? Open [an issue](../../issues) with the link of your STT or send a pull request to update the list directly.
 Wanna add your STT in the list? Open [an issue](../../issues) with the link of your STT or send a pull request to update the list directly.
 
 
 
 

+ 7 - 5
Docs/trigger.md

@@ -28,8 +28,10 @@ Then, open an issue or create a pull request to add the model to the list bellow
 
 
 ## List of available Snowboy Kalliope model
 ## List of available Snowboy Kalliope model
 
 
-| Name                                                | language | Pronouced     |
-|-----------------------------------------------------|----------|---------------|
-| [kalliope-FR](https://snowboy.kitt.ai/hotword/1363) | French   | Ka-lio-pé     |
-| [kalliope-EN](https://snowboy.kitt.ai/hotword/2540) | English  | kə-LIE-ə-pee  |
-| [kalliope-RU](https://snowboy.kitt.ai/hotword/2964) | Russian  | каллиопа      |
+> **Important note:** Do not enhance a model in the wrong language. Check the pronunciation before recording your voice!
+
+| Name                                                | language | Pronounced     |
+|-----------------------------------------------------|----------|----------------|
+| [kalliope-FR](https://snowboy.kitt.ai/hotword/1363) | French   | Ka-lio-pé      |
+| [kalliope-EN](https://snowboy.kitt.ai/hotword/2540) | English  | kə-LIE-ə-pee   |
+| [kalliope-RU](https://snowboy.kitt.ai/hotword/2964) | Russian  | каллиопа       |

+ 1 - 6
Docs/tts.md

@@ -50,13 +50,8 @@ cache_path: "/tmp/kalliope_tts_cache"
 generated audio files that will not be played more than once.
 generated audio files that will not be played more than once.
 
 
 ## Current Available TTS
 ## Current Available TTS
-Core TTSs are already packaged with the installation of Kalliope an can be used out of the box.
 
 
-- [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)
+Core TTSs are already packaged with the installation of Kalliope an can be used out of the box. See the [complete list here](tts_list.md).
 
 
 ## TTS Community Installation
 ## TTS Community Installation
 
 

+ 10 - 10
Docs/tts_list.md

@@ -6,22 +6,22 @@ See the [complete TTS documentation](stt.md) for more information.
 ## Core TTS
 ## Core TTS
 Core TTSs are already packaged with the installation of Kalliope an can be used out of the box.
 Core TTSs are already packaged with the installation of Kalliope an can be used out of the box.
 
 
-| Name      | Description                                      |
-|-----------|--------------------------------------------------|
-| Acapela   | [Acapela](../kalliope/tts/acapela/README.md)     |
-| GoogleTTS | [GoogleTTS](../kalliope/tts/googletts/README.md) |
-| VoiceRSS  | [VoiceRSS](../kalliope/tts/voicerss/README.md)   |
-| Pico2wave | [Pico2wave](../kalliope/tts/pico2wave/README.md) |
-| Voxygen   | [Voxygen](../kalliope/tts/voxygen/README.md)     |
+| Name      | Description                                      | Type        |
+|-----------|--------------------------------------------------|-------------|
+| Acapela   | [Acapela](../kalliope/tts/acapela/README.md)     | Cloud based |
+| GoogleTTS | [GoogleTTS](../kalliope/tts/googletts/README.md) | Cloud based |
+| VoiceRSS  | [VoiceRSS](../kalliope/tts/voicerss/README.md)   | Cloud based |
+| Pico2wave | [Pico2wave](../kalliope/tts/pico2wave/README.md) | Self hosted |
+| Voxygen   | [Voxygen](../kalliope/tts/voxygen/README.md)     | Cloud based |
 
 
 ## Community TTS
 ## Community TTS
 Community TTSs need to be installed manually.
 Community TTSs need to be installed manually.
 
 
 To know how to install a community TTS, read the "Installation" section of the [TTS documentation](tts.md).
 To know how to install a community TTS, read the "Installation" section of the [TTS documentation](tts.md).
 
 
-| Name   | Description                                          |
-|--------|------------------------------------------------------|
-| Espeak | [Espeak](https://github.com/Ultchad/kalliope-espeak) |
+| Name   | Description                                          | Type        |
+|--------|------------------------------------------------------|-------------|
+| Espeak | [Espeak](https://github.com/Ultchad/kalliope-espeak) | Self hosted |
 
 
 Wanna add your TTS in the list? Open [an issue](../../issues) with the link of your TTS or send a pull request to update the list directly.
 Wanna add your TTS in the list? Open [an issue](../../issues) with the link of your TTS or send a pull request to update the list directly.