]> git.parisson.com Git - telemeta.git/commitdiff
cleanup install doc
authoryomguy <yomguy@parisson.com>
Thu, 27 Jan 2011 14:20:12 +0000 (15:20 +0100)
committeryomguy <yomguy@parisson.com>
Thu, 27 Jan 2011 14:20:12 +0000 (15:20 +0100)
INSTALL

diff --git a/INSTALL b/INSTALL
index 578e5e03625de71b2671590d28a94606b031b01f..bff5f5e6932a8fe7dfb7b435bf0f386a254d0c0a 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -2,30 +2,24 @@
 Telemeta - INSTALL
 ==================
 
-Requirements
-============
+-----------------
+0. Requirements
+-----------------
 
 Telemeta is designed to run on Linux and other UNIX based architectures.
-The following third party applications or libraries are required:
-
-:dependencies: python python-xml python-mutagen python-django \
-              python-imaging python-mysqldb mysql-server python-numpy python-scipy \
-               python-ctypes python-setuptools python-support python-docutils
-
-Here, package names are taken from the Debian OS and could be different on other platforms.
+It depends on several python librairies like Django (version >= 1.1.1).
+See http://djangoproject.com.
 
-
-Install
-=======
+Other needed librairies are listed below.
 
 -----------------------
 1. Install the software
 -----------------------
 
-1.1 Install Telemeta
---------------------
+Install the dependencies
+-------------------------
 
-* On Debian (Testing recommended) or Ubuntu Hoary
+* On Debian (Squeeze recommended) or Ubuntu Lucid:
 
     Install all dependencies like this::
        
@@ -37,36 +31,19 @@ Install
 
         deb http://debian.parisson.org/ binary/
         deb-src http://debian.parisson.org/ source/
-        deb http://www.debian-multimedia.org etch main
+        deb http://www.debian-multimedia.org stable main
 
     Then::
 
-    $ sudo apt-get update
-    $ sudo apt-get install telemeta
-
-    This method provides the installation of all needed packages
-    thanks to the Debian dependency system.
-    Go to 1.2.
-
-* On other linux platforms
-
-    Install all dependencies.
-
-    Download the latest release of telemeta at
-    http://telemeta.org
-
-    Uncompress the archive like::
-
-    $ tar xzvf telemeta_0.3.2.tar.gz
+        sudo apt-get update
 
-    Go to the main folder of telemeta and run this command
-    in a shell as root::
+* On other linux platforms:
 
-    $ sudo python setup.py install
+    Please install all dependencies thanks to your application manager.
 
 
-1.2. Install TimeSide
----------------------
+Install TimeSide
+-----------------
 
 In order to get all the Web Audio Components from TimeSide,
 you have to download and install it from source.
@@ -76,24 +53,35 @@ http://code.google.com/p/timeside/downloads/list
 
 Install it like in the following example::
 
-$ tar xzf timeside-0.2.tar.gz
-$ cd timeside-0.2
+    tar xzf timeside-0.2.tar.gz
+    cd timeside-0.2
 
 Read the README and INSTALL file, install dependencies and then::
 
-$ sudo python setup.py install
+    sudo python setup.py install
+
+
+    
+Install Telemeta
+------------------
+
+* On Debian style systems, if you have added our repositories::
+
+    sudo apt-get install telemeta
 
+* Else:
 
-1.3. Install the Django framework version 1.0
----------------------------------------------
+    Download the latest release of telemeta at
+    http://telemeta.org
 
-* On Debian (Lenny recommended) or Ubuntu Hoary::
+    Uncompress the archive like::
 
-    $ sudo apt-get install python-django
+        tar xzvf telemeta_0.5.1.tar.gz
 
-* On other linux platforms, download and install it from:
+    Go to the main folder of telemeta and run this command
+    in a shell as root::
 
-    http://www.djangoproject.com/download/
+        sudo python setup.py install
 
 
 --------------------------
@@ -102,8 +90,8 @@ $ sudo python setup.py install
 
 If you haven't already done it, start a new django project::
 
-    cd ~/my_projects
-    django-admin startproject mysite
+    cd ~/my_projects
+    django-admin startproject mysite
 
 
 -----------------------------------------
@@ -112,10 +100,11 @@ If you haven't already done it, start a new django project::
 
 We need 2 directories for media and caching::
 
-    $ cd mysite
-    $ mkdir media cache
+    cd mysite
+    mkdir media cache cache/data cache/export
+
 
-You might want to place these somewhere else...
+You might want to place these data directories somewhere else, no pb.
 
 
 ----------------------------------
@@ -125,21 +114,18 @@ You might want to place these somewhere else...
 Edit the file settings.py in a text editor.
 Modifiy the following variables:
 
-    :ADMINS:            telemeta requires that you indicate an administrator here
-    :DATABASE_*:        your database settings (don't forget to create the database if needed)
-    :MEDIA_ROOT:        absolute path to the media directory you just created
-    :INSTALLED_APPS:    add 'telemeta'
-    :TEMPLATE_CONTEXT_PROCESSORS: include 'django.core.context_processors.request' and
-                                  'django.core.context_processors.auth' in this tuple
-
+    ADMINS =            telemeta requires that you indicate an administrator here
+    DATABASE_* =        your database settings (don't forget to create the database if needed)
+    MEDIA_ROOT =        absolute path to the media directory you just created
+    INSTALLED_APPS =    add 'telemeta' to the tuple
+    
 Add the following variables:
 
-    :TELEMETA_ORGANIZATION: name of the organization which hosts this installation
-    :TELEMETA_SUBJECTS:     tuple of subject keywords (used for Dublin Core), such
-                            as "Ethnology", etc...
-    :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 audio data download
+    TELEMETA_ORGANIZATION =  name of the organization which hosts this installation
+    TELEMETA_SUBJECTS =      tuple of subject keywords (used for Dublin Core), such as "Ethnology", etc...
+    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 audio data download
 
 Just paste the lines below::
 
@@ -156,7 +142,7 @@ Just paste the lines below::
 
 This synchronizes the DB with the model::
 
-    python manage.py syncdb
+    python manage.py syncdb
 
 
 ----------------------
@@ -174,11 +160,11 @@ This synchronizes the DB with the model::
 
 We are ready to start the telemeta server::
 
-    python manage.py runserver
+    python manage.py runserver
 
 By default, the server starts on the port 8000. You can override this with, for example::
 
-    python manage.py runserver 9000
+    python manage.py runserver 9000
 
 
 ------------------------------------