README

README.md

@@ -0,0 +1,53 @@
+LiveConding Console
+===================
+
+LiveConding Console provides a cli to list and play streams for livecoding.tv.
+
+Requirements
+------------
+
+* PHP >= 5.4
+* Composer (php)
+
+Installation
+------------
+
+	$ git clone https://gitlab.deblan.org/deblan/livecoding-console
+	$ cd livecoding-console
+	$ composer update
+
+### Composer
+
+Composer can maybe be downloaded from your system's repositories.
+Else, follow the next instructions:
+
+#### Download
+
+    # With cURL
+    curl -sS https://getcomposer.org/installer | php
+
+    # With Wget
+    wget -O - -q https://getcomposer.org/installer | php
+
+You can now use it with `php composer.phar [arguments]`.
+
+#### Executable
+
+    mv composer.phar composer
+    chmod +x composer
+
+Use it with `./composer [arguments]`.
+
+#### Install
+
+Assuming `~/bin` exists ans is in `$PATH`.
+
+    mv composer ~/bin
+
+#### Dependencies Installation (from `composer.lock`)
+
+    composer install
+
+#### Dependencies Update (will change `composer.lock`)
+
+    composer update