From: yomguy <yomguy@parisson.com>
Date: Tue, 7 Feb 2012 00:35:36 +0000 (+0100)
Subject: fix doc
X-Git-Tag: 1.3.9
X-Git-Url: https://git.parisson.com/?a=commitdiff_plain;h=da0b26b77643224ecb8792a2b58d99bd12aaceb0;p=telemeta.git

fix doc
---

diff --git a/INSTALL.rst b/INSTALL.rst
index 43c0296f..4bd90495 100644
--- a/INSTALL.rst
+++ b/INSTALL.rst
@@ -23,30 +23,27 @@ Install the system dependencies
     Install all dependencies like this::
 
         sudo aptitude install python python-dev python-django python-xml python-mysqldb mysql-server \
-        python-ctypes python-setuptools python-support python-docutils \
-        python-libxml2 python-django-registration python-lxml python-numpy \
-        python-scipy python-imaging python-mutagen python-gobject python-gst0.10 \
-        gstreamer0.10-plugins-base gobject-introspection python-django-south
+            python-ctypes python-setuptools python-support python-docutils \
+            python-libxml2 python-django-registration python-lxml python-numpy \
+            python-scipy python-imaging python-mutagen python-gobject python-gst0.10 \
+            gstreamer0.10-plugins-base gobject-introspection python-django-south
 
-    To get MP3 reading and writing, just add these lines to your /etc/apt/sources-list::
-
-        deb http://www.debian-multimedia.org stable main
-
-    Then::
+    To get MP3 reading and writing::
 
+        echo 'deb http://www.debian-multimedia.org stable main' | sudo tee -a /etc/apt/sources-list
         sudo apt-get update
         sudo aptitude install gstreamer0.10-fluendo-mp3 gstreamer0.10-lame
 
 * On other linux platforms:
 
-    Please install all dependencies thanks to your application manager.
+    Please install all the equivalent dependencies thanks to your application manager or manually.
 
 
 Install Telemeta
 -----------------------------
 
-Pip style (recommended)
-++++++++++++++++++++++++
+Pip method (highly recommended!)
++++++++++++++++++++++++++++++++++
 
 We strongly advise you use the python package tool as it installs some good dependencies automatically::
 
@@ -122,9 +119,9 @@ If you just want to test Telemeta, a sandbox is available in the example/ direct
 As Telemeta needs MySQL to work properly and fast, please create a database before editing setting.py
 
 
---------------------------
-Create a Django project
---------------------------
+-------------------------------
+Create a new Telemeta project
+-------------------------------
 
 Start the project
 ------------------
@@ -195,7 +192,8 @@ Add the following variables::
     TELEMETA_CACHE_DIR =            absolute path to the cache directory that you just created
     TELEMETA_GMAP_KEY =             your Google Map API key
     TELEMETA_DOWNLOAD_ENABLED =     True to enable raw audio data download
-    TELEMETA_STREAMING_FORMATS =    tuple of authoized streaming formats. Ex : ('mp3', 'ogg')
+    TELEMETA_STREAMING_FORMATS =    tuple of authorized streaming formats. Ex: ('mp3', 'ogg')
+    TELEMETA_DOWNLOAD_FORMATS =     tuple of authorized download formats. Ex: ('wav', 'mp3', 'webm')
     TELEMETA_PUBLIC_ACCESS_PERIOD = number of years above which item files are automagically published
     EMAIL_HOST =                    your default SMTP server
     DEFAULT_FROM_EMAIL =            the default sending email address
@@ -209,7 +207,7 @@ Just paste the lines below::
     TELEMETA_DATA_CACHE_DIR = TELEMETA_CACHE_DIR + "/data"
     CACHE_BACKEND = "file://" + TELEMETA_CACHE_DIR + "/data"
 
-If you want some personal templates, for example::
+Optional: if you want some personal templates, for example::
 
     TEMPLATE_DIRS = (
     '/home/dev/telemeta/sandboxes/sandbox_generic/templates/',
@@ -258,8 +256,9 @@ Initialize the database
 This synchronizes the DB with the model::
 
     ./manage.py syncdb
-    ./manage.py schemamigration telemeta --initial
-    ./manage.py migrate telemeta --fake
+
+If you want some data schema migrations (South needed)::
+
     ./manage.py migrate telemeta