Browse Source

Rewrite the Ubuntu 16.04 install documentation to use PIP or setup.py methods.

Thomas Pierson 8 years ago
parent
commit
a2f6fecba8
1 changed files with 75 additions and 13 deletions
  1. 75 13
      Docs/installation/ubuntu_16.04.md

+ 75 - 13
Docs/installation/ubuntu_16.04.md

@@ -1,39 +1,101 @@
 # Kalliope installation on Ubuntu 16.04
 
-## Automated install
+## Requirements
 
-Clone the project
+### Debian packages requirements
+
+Install some required system libraries and softwares:
+
+```
+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
+```
+
+## Installation
+
+### Method 1 - User install using the PIP package
+
+You can install kalliope on your system:
+```
+sudo pip install kalliope
+```
+
+Or just in your user home:
+```
+pip install --user kalliope
+```
+
+Run Kalliope:
+```
+kalliope start
+```
+
+### Method 2 - Manual user install using the git repository
+
+Clone the project:
 ```
-cd
 git clone https://github.com/kalliope-project/kalliope.git
 ```
 
-Run the install script.
+Install the project:
 ```
-./kalliope/install/install_kalliope.sh
+sudo python setup.py install
 ```
 
-## Manual install
+Run Kalliope from a shell:
+```
+kalliope start
+```
 
-To make Kalliope work, you will have to install a certain number of libraries:
+### Method 3 - Developer install using Virtualenv
+
+Install the `python-virtualenv` package:
 ```
-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 python-virtualenv
+```
+
+Clone the project:
+```
+git clone https://github.com/kalliope-project/kalliope.git
+cd kalliope
+```
+
+Generate a local python environment:
+```
+virtualenv venv
 ```
 
-Clone the project
+Install the project using the local environment:
+```
+venv/bin/pip install --editable .
+```
+
+Run Kalliope from a shell:
+```
+venv/bin/kalliope start
+```
+
+### Method 4 - Developer, dependencies install only
+
+Clone the project:
 ```
 git clone https://github.com/kalliope-project/kalliope.git
+cd kalliope
+```
+
+Install the python dependencies directly:
+```
+sudo pip install -r install/python_requirements.txt
 ```
 
-Install libs
+Run Kalliope from a shell directly:
 ```
-sudo pip install -r install/files/python_requirements.txt
+python kalliope.py start
 ```
 
 ## Test your env
 
-To ensure that you can record your voice, run the following command to capture audio input 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
 ```