update doc

README.md

@@ -6,12 +6,39 @@ Platform to manage a radio. We use the power of Django
 * **diffusions**: generate diffusions time slot for programs that have schedule informations. Check for conflicts and rerun.
 * **liquidsoap**: create a configuration to use liquidsoap as a stream generator. Also provides interface and control to it;
 * **sounds**: each programs have a folder where sounds can be put, that will be detected by the system. Quality can be check and reported for later use. Later, we plan to have uploaders to external plateforms. Sounds can be defined as excerpts or as archives.
-* **cms**: a small CMS to generate a website with all cool informations related to programs and diffusions. On the contrary of other plateform, we keep programs and content management seperate.
+* **cms**: a small CMS to generate a website with all cool informations related to programs and diffusions. On the contrary of some other plateforms, we keep program and content management distinct.
 * **log**: keep a trace of every played/loaded sounds on the stream generator.
 
 ## Applications
 * **programs**: managing stations, programs, schedules and diffusions. This is the core application, that handle most of the work.
-* **cms**: cms manager with reusable tools.
-* **liquidsoap**: liquidsoap controls.
+* **cms**: [optional] cms manager with reusable tools (can be used in another website application).
+* **liquidsoap**: [optional] generate configuration and controls over liquidsoap. We use one instance of liquidsoap per station.
+
+## Installation
+For now, we provide only applications availables under the aircox directory. Create a django project, and add the aircox applications directory.
+
+Later we would provide a package, but now we have other priorities.
+
+### settings.py
+* There must be `BASE_DIR` or `PROJECT_ROOT` defined in order to make liquidsoap working (that must call manage.py using an absolute path).
+* INSTALLED_APPS:
+    - dependencies: `'taggit'`, `'easy_thumbnails'`
+    - optional dependencies (in order to make users' life easier): `'autocomplete_light'`, `'suit'`
+    - aircox: `'aircox.programs'`, `'aircox.liquidsoap'`, `'aircox.cms'`
+
+### urls.py
+* dependencies:
+
+    ```python
+    url(r'^autocomplete/', include('autocomplete_light.urls')), # autocomplete
+    ```
+
+* aircox:
+
+    ```python
+     # if using liquidsoap
+    url(r'^liquidsoap/', include('aircox.liquidsoap.urls')),
+    ```
+