]> git.parisson.com Git - telemeta.git/commitdiff
Rewrite README and INSTALL
authoryomguy <>
Thu, 21 Feb 2008 18:47:24 +0000 (18:47 +0000)
committeryomguy <>
Thu, 21 Feb 2008 18:47:24 +0000 (18:47 +0000)
COPYING
INSTALL
README
debian/control

diff --git a/COPYING b/COPYING
index 53ca0bbaae7c898ce2b2dd6a784006cb951e5873..3bd197313feef284c1e0110842770059006e80dd 100644 (file)
--- a/COPYING
+++ b/COPYING
@@ -1,5 +1,5 @@
-Copyright (c) 2006, 2007 Parisson, SARL (parisson.com).
-Copyright (c) 2006, 2007 Samalyse, SARL (samalyse.com).
+Copyright (c) 2006, 2008 Parisson, SARL (parisson.com).
+Copyright (c) 2006, 2008 Samalyse, SARL (samalyse.com).
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
diff --git a/INSTALL b/INSTALL
index bc2f132113eb3b1c439d44afcacaab9aff9f52c4..14b44efe0edff74feb79a33d08f89b402de94ffb 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -5,15 +5,18 @@
 # 1. Requirements
 # ===============
 
-python, (python-central ?), python-xml, shout-python, libshout3, icecast2
+python (>= 2.3.5-7), python-xml, python-central (>= 0.5),
+python-mutagen, python-django (>= 0.96.1), sox, vorbis-tools, flac, normalize-audio,
+ecasound, festival, par2, python-mysqldb, sqlite3 | mysql-server, octave2.9,
+octave2.9-forge, python-tk, libgd2-noxpm, libsndfile
 
-Note that shout-python is included in this release and is installed together with d-fuzz
 
+# 2. Install
+# ==========
 
-# 2. Donwload
-# ===============
+2.1. Install Telemeta:
 
- * On debian or Ubuntu just add these lines to your /etc/apt/sources-list:
+* On debian or Ubuntu just add these lines to your /etc/apt/sources-list:
 
     deb http://debian.parisson.org/ binary/
     deb-src http://debian.parisson.org/ source/
@@ -21,27 +24,72 @@ Note that shout-python is included in this release and is installed together wit
 
     Then,
 
-    sudo apt-get update
-    sudo apt-get install d-fuzz
+    sudo apt-get update
+    $ sudo apt-get install telemeta
 
- * On other linux platforms, install all dependencies and get the lastest tar.gz
-   version on :
+* On other linux platforms, install all dependencies listed in §1.
+  and get the lastest tar.gz version of telemeta at http://debian.parisson.org/
+  Uncompress the archive, go to the main folder of telemeta and run this command
+  in a shell as root:
 
-    http://debian.parisson.org/
+    $ python setup.py install
 
-    Uncompress the archive.
+* Compile wav2png in telemeta/telemeta/visualization/wav2png
 
- * You can also get the lastest develoment version with subversion:
+2.2. Create a Django project if you haven't already done it:
 
-    svn co http://svn.parisson.org/svn/telemeta/trunk telemeta
+    $ cd ~/my_projects
+    $ django-admin startproject mysite
 
-# 3. Installation
-# ===============
+2.3. Put a link to telemeta into your Django project:
+
+    $ ln -s ~/my_apps/telemeta/telemeta ~/my_projects/mysite/telemeta
+
+    OR: add the telemeta path to PYTHONPATH
+
+2.4. Create the media and cache directories:
+
+    $ cd mysite
+    $ mkdir media cache
+
+    You might want to place these somewhere else
+
+2.5. Configure Django (settings.py):
+
+    Modifiy the following variables:
+
+    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 'mysite.telemeta'
+
+    Add the following variables:
+
+    TELEMETA_CACHE_DIR: absolute path to the cache directory you just created
+
+    Just paste the two lines below:
+    TELEMETA_EXPORT_CACHE_DIR = TELEMETA_CACHE_DIR + "/export"
+    CACHE_BACKEND = "file://" + TELEMETA_CACHE_DIR + "/data"
+
+2.6. Initialize the database:
+
+    $ python manage.py syncdb
+
+2.7. Configure your urls:
+
+    The simplest case is to have telemeta running at public root. To do so, add
+    this url in urls.py :
+
+    (r'^', include('telemeta.urls')),
+
+2.8. Start the project:
+
+    $ python manage.py runserver
+
+2.9. Go the web page:
 
-run this command in a shell as root :
+    http://localhost:8000
 
-    python setup.py install
 
 
-See README and http://parisson.com/d-fuzz/ for more informations.
+See README and http://svn.parisson.org/telemeta/ for more informations.
 
diff --git a/README b/README
index 81a2f68453bafb0c988581627d3f4106aa9a4905..d79d9a95e39a3155c1e58870b1cbee5e10ce7afe 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,7 @@
 # README
 # ======
 
-Telemeta: backups, transcodes, tags and marks any audio content with metadata
+Telemeta: web frontend to backup, transcode and tag any audio content with metadata
 
 
 # 1. Introduction
@@ -45,88 +45,35 @@ octave2.9-forge, python-tk
 # 3. Installation and usage
 # =========================
 
-1 - Checkout Telemeta:
-
-    $ cd ~/my_apps
-    $ svn co http://svn.parisson.org/svn/telemeta/trunk telemeta
-
-    Compile wav2png in telemeta/telemeta/visualization/wav2png (you will need
-    libgd and libsndfile for that)
-
-2 - Install the development version of the Django framework:
-
-    Warning: last know revision that works with Telemeta: 5313
-    See http://www.djangoproject.com
-
-3 - Create a Django project if you haven't already done it:
-
-    $ cd ~/my_projects
-    $ django-admin startproject mysite
-
-4 - Put a link to telemeta into your Django project:
-
-    $ ln -s ~/my_apps/telemeta/telemeta ~/my_projects/mysite/telemeta
-
-    OR: add the telemeta path to PYTHONPATH
-
-5 - Create the media and cache directories:
-
-    $ cd mysite
-    $ mkdir media cache
-
-    You might want to place these somewhere else
-
-6 - Configure Django (settings.py):
-
-    Modifiy the following variables:
-
-    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 'mysite.telemeta'
-
-    Add the following variables:
-
-    TELEMETA_CACHE_DIR: absolute path to the cache directory you just created
-
-    Just paste the two lines below:
-    TELEMETA_EXPORT_CACHE_DIR = TELEMETA_CACHE_DIR + "/export"
-    CACHE_BACKEND = "file://" + TELEMETA_CACHE_DIR + "/data"
-
-7 - Initialize the database:
-
-    $ python manage.py syncdb
-
-8 - Configure your urls:
-
-    The simplest case is to have telemeta running at public root. To do so, add 
-    this url in urls.py :
-
-    (r'^', include('telemeta.urls')),
+See INSTALL and http://svn.parisson.org/telemeta for more informations.
 
-9 - Start the project:
 
-    $ python manage.py runserver 
+# 4. Development
+# ===============
 
-10 - Go the web page:
+To participate to the development of telemeta, you will need a login/password couple.
+You're welcome to email us to get one and commit your great ideas ;) (see §6.).
 
-    http://localhost:8000
+To get the lastest development version, you need subversion and run :
 
+    $ svn co http://svn.parisson.org/svn/telemeta/trunk telemeta
 
-See INSTALL and http://svn.parisson.org/telemeta for more informations.
 
+# 5. Bugs and feedback
+# ====================
 
-# 4. Feedback
-# ===========
+If you find some bugs, please leave a ticket on this page:
 
-Please give me some feedback. Tell me if Telemeta suits you or if you
-would need some other interesting features.  You are welcome to mail me
-at <yomguy@altern.org>
+    http://svn.parisson.org/telemeta/newticket
+    
+You can also leave a ticket to request some new interesting features for the next versions.
+And even if Telemeta suits you, please give us some feedback (see §6.) !
 
 
-# 5. Contact
+# 6. Contact
 # ==========
 
-Home page : http://svn.parisson.org/telemeta
-E-mails    : Guillaume Pellerin <yomguy@altern.org>
-             Olivier Guilyardi <olivier@samalyse.com>
+Homepage:   http://svn.parisson.org/telemeta
+Emails:     Guillaume Pellerin <pellerin@parisson.com>
+            Olivier Guilyardi <olivier@samalyse.com>
              
index 99a3ce2a7cb9c8cdd43f2ad2f8c123bd9a5a999a..799f619571842f5ca53a75d35d654ad2d9473692 100644 (file)
@@ -16,7 +16,7 @@ ecasound, festival, par2, python-mysqldb, sqlite3 | mysql-server, octave2.9,
 octave2.9-forge, python-tk
 Suggests: lame
 XB-Python-Version: ${python:Versions}
-Description: backups, transcodes, tags and marks any audio content with metadata
+Description: web frontend to backup, transcode and tag any audio content with metadata
 Telemeta is a global audio archiving program which introduces useful and secure
 indexing methods to backup digitalized audio files and metadata dictionnaries.
 It is dedicated to backup any digitized and documented sound from collections of