Debogage global et redaction du README

README.md

@@ -0,0 +1,110 @@
+# sayy.sh
+
+This script enables any debian based GNU/Linux distribution to talk! Based on Google's text to speach Android application, it gives you a few commands to ease your TTS experience on Linux.
+
+## Setup
+
+### Prerequisites
+
+Before installing the script, you will need to install a few dependencies:
+
+. libttspico-utils
+. sox
+. dialog
+. xsel
+
+To install all them at once type the following command:
+
+```
+sudo apt-get install libttspico-utils sox dialog xsel
+```
+
+As libttspico-utils is a non-free package, it may not be available in your default packqge repositories.
+
+## Install
+
+To start installing the script simply type:
+
+```
+. say.sh install
+```
+
+This will go through a few operations required for it to work properly:
+
+. creation of a /home/user/bin/say directory
+. moving the script to newly created directory
+. creating and setting config file within nely created directory
+. adding an instruction to /gome/user/.bashrc file
+. reloading .bashrc file
+
+## Configuration
+
+During setup a default configuration will be set. You still can change it using the **saycfg** command. This command takes 3 arguments: language, volume and speed.
+
+Example:
+
+This command sets language to US English, volume to 1.2 and speed to 0.8
+
+```
+saycfg en-US 1.2 0.8
+```
+
+The script supports over to 6 different languages. Volume and speed can differ from 0.5 to 1.5.
+
+### Available languages
+
+**en-GB** British English
+
+**en-US** US English
+**fr-FR** French
+**de-DE** Deutsch
+**es-ES** Spanish
+**it-IT** Italiam
+
+## Commands
+
+### say
+
+Start text interpretation and reading.
+
+#### Basic usage
+
+```
+say Hello World!
+```
+
+#### Live changing language
+
+If default configuration language doesn't fit with a text written in different language, you can overwrite it in command call.
+
+```
+say it-IT Buongiorno a tutti!
+```
+
+#### Using standard input
+
+```
+echo "Salut tout le monde!" | say
+```
+
+Even using standard input, language can still be overwrittem:
+
+```
+echo "I love this app!" | say en-GB
+```
+
+### saycfg
+
+Set full configuration
+
+```
+saycfg es-ES 1 1
+```
+
+### saylng
+
+Sets current languages in configuration
+
+```
+saylng de-DE
+```