]> git.parisson.com Git - telemeta.git/commitdiff
rewrite description and urls
authoryomguy <>
Mon, 16 Mar 2009 23:02:08 +0000 (23:02 +0000)
committeryomguy <>
Mon, 16 Mar 2009 23:02:08 +0000 (23:02 +0000)
INSTALL
README

diff --git a/INSTALL b/INSTALL
index d0cb52b98dfb6166092817ddad0aeaf02fbbe0c5..3b531b84358093c9facc6bdf109687a32f9707c1 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -5,6 +5,9 @@
 # 1. Requirements
 # ===============
 
+Telemeta is designed to run on Linux and other UNIX based architectures.
+The following third party applications or libraries are required:
+
 python (>= 2.3.5-7), python-xml, python-mutagen, python-django (>= 1.0-1),
 python-imaging (>= 1.1.6), sox, vorbis-tools, flac, normalize-audio,
 python-mysqldb, mysql-server, octave2.9, python-tk, libgd2-xpm,
@@ -13,12 +16,15 @@ python-scikits-audiolab (>= 0.7), python-setuptools (>= 0.6b3),
 python-support (>= 0.3),
 
 optional:
-lame, ecasound, par2
+lame, ecasound, festival, par2
+
 
 # 2. Install
 # ==========
 
-2.1.1 Install Telemeta:
+2.1. Install the software
+
+    2.1.1 Install Telemeta:
 
     * On Debian (Testing recommended) or Ubuntu Hoary :
 
@@ -44,40 +50,40 @@ lame, ecasound, par2
 
         Download the lastest release of telemeta at
 
-        http://svn.parisson.org/telemeta/
+        http://telemeta.org
 
         Uncompress the archive like :
 
         $ tar xzvf telemeta_0.3.2.tar.gz
-        
+
         Go to the main folder of telemeta and run this command
         in a shell as root:
 
         $ sudo python setup.py install
 
 
-2.1.2. Install audiolab
+    2.1.2. Install audiolab
 
     This is ONLY needed if you did NOT install telemeta with Debian's apt-get.
 
     In order to get the wavforms of the audio files,
     python-audiolab have to be installed in telemeta :
-    
+
     $ svn export http://svn.scipy.org/svn/scikits/trunk/audiolab
     $ cd audiolab/
     $ sudo python setup.py install
 
 
-2.1.3. Install the Django framework version 1.0:
+    2.1.3. Install the Django framework version 1.0:
 
-    * On Debian (Testing recommended) or Ubuntu Hoary :
+    * On Debian (Lenny recommended) or Ubuntu Hoary :
 
         $ sudo apt-get install python-django
 
     * On other linux platforms, download and install from:
 
         http://www.djangoproject.com/download/
-        
+
 
 2.2. Create a Django project if you haven't already done it:
 
@@ -131,14 +137,14 @@ lame, ecasound, par2
     You can override this with, for example:
 
     $ python manage.py runserver 9000
-    
 
-2.8. Go the web page:
+
+2.8. Go the web page with your browser:
 
     http://localhost:8000
     or
     http://localhost:9000
 
 
-See README and http://svn.parisson.org/telemeta/ for more informations.
+See README and http://telemeta.org for more informations.
 
diff --git a/README b/README
index c9adfee6f5af9a83963aef8071d5302e92708303..3ac39de75ea4ba13b6563fce2ae422d543ef28ba 100644 (file)
--- a/README
+++ b/README
@@ -1,41 +1,40 @@
-=================
-Telemeta - README
-=================
+=================
+Telemeta - README
+=================
 
-Telemeta: web frontend to backup, transcode and tag any audio content with metadata
+Telemeta: web frontend to backup, analyse, transcode and stream any audio content with metadata
 
 
-Introduction
-============
+Introduction
+============
 
-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
-vinyls, magnetic tapes or audio CD over a strong database in accordance with
-many standards. Export functions also encapsulate edited metadata into
-compressed file. The object style architecture will soon provide user-friendly
-interfaces and plugin' style audio processing.
+Telemeta is a web audio archiving program which introduces useful and secure methods to
+backup, index, transcode, analyse and publish any digitalized audio file with its metadata.
+It is dedicated to professionnals who wants to easily backup and publish documented sounds
+from collections of vinyls, magnetic tapes or audio CDs over a strong database, in accordance
+with open standards.
 
 Here are the main features of Telemeta: 
 
-    * Secure media editing and archiving over networks.
-    * Easy transcoding
-    * Full tagging and marking methods
+    * Secure archiving, editing and publishing of audio files over internet.
+    * "On the fly" transcoding and metadata encapsulating (FLAC, OGG, MP3, WAV, etc..)
+    * User friendly web frontend including workflows and high level search methods
+    * Smart dynamical and skinable audio player (thanks to Timeside)
+    * "On the fly" complex audio analyzers based on an easy plugin architecture
+    * Strong SQL backend
     * XML metadata backup
-    * Web interface introducing WorkFlow.
-    * SQL backend (still in dev from march 2007).
-    * Data anti-corruption security with par2 recovery keys
-    * Data synchronizing over remote servers (rsync)
-    * Auto AudioMarking? from metadata (thanks to Festival and Ecasound) 
+    * Auto audio-marking with synthetized voices reading metadata (optional)
+    * Anti-corruption data security management with par2 recovery keys
+    * Data synchronizing over remote servers (rsync + ssh methods)
 
-The Telemeta concept is based on collections. A collection includes original
-sounds - or albums containing sounds - which will be backuped in a secure way
-with a view of transcoded 'public' formats (WAV, FLAC, MP3, OGG and many more
-soon...) including metadata editing and publishing tools.
+The Telemeta data model is based on 'collections' and 'items'. A collection is described
+by its metadata and includes original audio items (sounds) and its own metadata. This
+existing model has been designed to fit the one of the French Centre of Etnomusicology (CREM)
+but could be easily adapted/overrided to sue other data stuctures.
 
 
-Requirements
-============
+Requirements
+============
 
 python (>= 2.3.5-7), python-xml, python-central (>= 0.5),
 python-mutagen, python-django, sox, vorbis-tools, flac, normalize-audio,
@@ -43,36 +42,43 @@ ecasound, festival, par2, python-mysqldb, sqlite3 | mysql-server, octave2.9,
 octave2.9-forge, python-tk, python-numpy, python-audiolab, libsndfile1
 
 
-Installation and usage
-======================
+Installation and usage
+======================
 
 See INSTALL and http://telemeta.org for more informations.
 
 
-Development
-===========
+Development
+===========
 
 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.).
+You're welcome to email us to join and commit your great ideas ;)
 
-To get the lastest development version, you need subversion and run::
+To get the lastest development version, you need subversion and run:
 
     $ svn co http://svn.parisson.org/svn/telemeta/trunk telemeta
 
 
-Bugs and feedback
-=================
+# Licence
+=======
 
-If you find some bugs, please leave a ticket on this page:
+CeCILL v2 (see COPYING)
+
+
+# Bugs and feedback
+# =================
+
+You are welcome to freely use this application in accordance to its licence.
+If you find some bugs, PLEASE leave a ticket on this page:
 
     http://telemeta.org/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.) !
 
 
-Contact
-=======
+Contact
+=======
 
 Homepage: 
     http://telemeta.org