Selaa lähdekoodia

Merge branch 'dev' into tests

monf 8 vuotta sitten
vanhempi
commit
430a694a79

+ 0 - 29
Docs/automated_install.md

@@ -1,29 +0,0 @@
-# kalliope automated install
-
-Clone the project
-```
-cd
-git clone https://github.com/kalliope-project/kalliope.git
-```
-
-Run the install script.
-```
-./kalliope/install/install_kalliope.sh
-```
-
->**Note:** The install script must not be ran as root or with sudo. 
-You will be prompted to enter your sudo password during the installation process.
-
-To ensure that you can record your voice, run the following command to capture audio input from your microphone
-```
-rec test.wav
-```
-
-Press CTRL-C after capturing a sample of your voice.
-
-Then play the recorded audio file
-```
-play test.wav
-```
-
-If everything is ok, you can start playing with Kalliope. First, let's take a look to the [default settings](settings.md).

+ 0 - 47
Docs/dev_env_install.md

@@ -1,47 +0,0 @@
-# Dev environment installation
-
-This documentation aims at explaining step by step manual deployment of Kalliope.
-
-Tested env
-- Ubuntu 16.04
-- Raspbian Jessie 
-
-
-
-## Prerequisites
-
-### Packages installation
-To make Kalliope work, you will have to install a certain number of libraries
-
-On Ubuntu distribution :
-```
-sudo apt-get install 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
-```
-
-### Test your env
-Run the following command to capture audio from your microphone
-```
-rec test.wav
-```
-
-Then play the recorded audio file
-```
-play test.wav
-```
-
-## Installation
-
-### Get the sources
-Clone the project
-```
-git clone https://github.com/kalliope-project/kalliope.git
-```
-
-### Python lib
-
-Install libs
-```
-sudo pip install -r install/files/python_requirements.txt
-```
-
-If you are running kalliope on a Raspberry Pi, you must perform some other step by [following the dedicated documentation](RPi.md).

+ 54 - 0
Docs/installation/debian_jessie.md

@@ -0,0 +1,54 @@
+# Kalliope installation on Debian Jessie
+
+## Automated install
+
+Clone the project
+```
+cd
+git clone https://github.com/kalliope-project/kalliope.git
+```
+
+Edit `/etc/apt/sources.list` and check that your mirror accept "non-free" package
+```
+deb http://ftp.fr.debian.org/debian/ jessie main contrib non-free
+deb-src http://ftp.fr.debian.org/debian/ jessie main contrib non-free
+```
+
+Run the install script.
+```
+./kalliope/install/install_kalliope.sh
+```
+
+## Manual install
+
+To make Kalliope work, you will have to install a certain number of libraries:
+```
+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
+```
+
+Clone the project
+```
+git clone https://github.com/kalliope-project/kalliope.git
+```
+
+Install libs
+```
+sudo pip install -r install/files/python_requirements.txt
+```
+
+## Test your env
+
+To ensure that you can record your voice, run the following command to capture audio input from your microphone
+```
+rec test.wav
+```
+
+Press CTRL-C after capturing a sample of your voice.
+
+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).

+ 42 - 2
Docs/RPi.md → Docs/installation/raspbian_jessie.md

@@ -1,3 +1,36 @@
+# Kalliope installation on Raspbian
+
+## Automated install
+
+Clone the project
+```
+cd
+git clone https://github.com/kalliope-project/kalliope.git
+```
+
+Run the install script.
+```
+./kalliope/install/install_kalliope.sh
+```
+
+## Manual install
+
+To make Kalliope work, you will have to install a certain number of libraries:
+```
+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
+```
+
+Clone the project
+```
+git clone https://github.com/kalliope-project/kalliope.git
+```
+
+Install libs
+```
+sudo pip install -r install/files/python_requirements.txt
+```
+
 # Raspberry Pi configuration
 
 This documentation deals with the special configuration needed for get kalliope working on a RPi.
@@ -88,13 +121,20 @@ Restart alsa to apply changes
 sudo /etc/init.d/alsa-utils restart
 ```
 
-Do not forget to test recording your voice:
+You can adjust the microphone sensibility by running alsamixer:
+```
+alsamixer
+```
+And then select your microphone device by pressing F6 and finally move up the `mic` sensibility level
+![logo](../../images/alsamixer_mic_level.png)
 
-Capture audio from your microphone
+To ensure that you can record your voice, run the following command to capture audio input from your microphone
 ```
 rec test.wav
 ```
 
+Press CTRL-C after capturing a sample of your voice.
+
 Then play the recorded audio file
 ```
 mplayer test.wav

+ 48 - 0
Docs/installation/ubuntu_16.04.md

@@ -0,0 +1,48 @@
+# Kalliope installation on Ubuntu 16.04
+
+## Automated install
+
+Clone the project
+```
+cd
+git clone https://github.com/kalliope-project/kalliope.git
+```
+
+Run the install script.
+```
+./kalliope/install/install_kalliope.sh
+```
+
+## Manual install
+
+To make Kalliope work, you will have to install a certain number of libraries:
+```
+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
+```
+
+Clone the project
+```
+git clone https://github.com/kalliope-project/kalliope.git
+```
+
+Install libs
+```
+sudo pip install -r install/files/python_requirements.txt
+```
+
+## Test your env
+
+To ensure that you can record your voice, run the following command to capture audio input from your microphone
+```
+rec test.wav
+```
+
+Press CTRL-C after capturing a sample of your voice.
+
+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).

+ 0 - 1
Docs/microphone_rpi.md

@@ -1 +0,0 @@
-# Tested microphone on Rpi

+ 4 - 4
README.md

@@ -8,7 +8,7 @@ Kalliope is based on audio input recognition, so it recognize an order pronounce
 You can create your own Kalliope bot, by simply choosing and composing the existing modules without writing any code. But, if you need a particular module, you can
 write it by yourself and add it to your project. You can also propose it to the community.
 
-Kalliope can run on all Linux distribution including a Raspberry Pi and it's multi-lang. The only thing you need is a microphone.
+Kalliope can run on all Linux Debian based distribution including a Raspberry Pi and it's multi-lang. The only thing you need is a microphone.
 
 Kalliope is easy-peasy to use, see the hello world
 ```
@@ -22,9 +22,9 @@ Kalliope is easy-peasy to use, see the hello world
 
 ## Installation
 
-- [Automated installation](Docs/automated_install.md)
-- [Manual installation for developement](Docs/dev_env_install.md)
-- [Raspberry Pi configuration](Docs/RPi.md)
+- [Raspbian Jessie(Raspberry pi)](Docs/installation/raspbian_jessie.md)
+- [Ubuntu 16.04](Docs/installation/ubuntu_16.04.md)
+- [Debian Jessie](Docs/installation/debian_jessie.md)
 
 ## Usage
 

BIN
images/alsamixer_mic_level.png