From 56d71a23539e39cf250b599669d0a711de75060d Mon Sep 17 00:00:00 2001 From: yomguy Date: Tue, 2 Oct 2012 16:00:51 +0200 Subject: [PATCH] update doc --- INSTALL.rst | 12 +++++++----- README.rst | 56 ++++++++++++++++++++++++++++++++++++++--------------- 2 files changed, 47 insertions(+), 21 deletions(-) diff --git a/INSTALL.rst b/INSTALL.rst index 618e842f..fd5f5aaf 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -23,12 +23,13 @@ Install the system dependencies 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-pip gir1.0-gstreamer-0.10 gstreamer0.10-plugins-good gstreamer0.10-plugins-bad - To get MP3 reading and writing:: + To get non-free (MP3, MP4, AAC, etc) decoding and encoding features, add Debian Multimedia repository and install the modules:: - echo 'deb http://www.debian-multimedia.org stable main' | sudo tee -a /etc/apt/sources-list + echo "deb http://www.deb-multimedia.org stable main non-free" | sudo tee -a /etc/apt/sources.list sudo apt-get update - sudo aptitude install gstreamer0.10-fluendo-mp3 gstreamer0.10-lame + sudo apt-get install gstreamer0.10-lame gstreamer0.10-plugins-really-bad gstreamer0.10-plugins-ugly * On other linux platforms: @@ -43,7 +44,6 @@ Pip method (highly recommended!) We strongly advise you use the python package tool as it installs some good dependencies automatically:: - sudo aptitude install python-pip sudo pip install telemeta or (deprecated):: @@ -72,7 +72,7 @@ But, if you need to hack Telemeta without installing it (i.e. link it through yo TimeSide (web audio components) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Install it using pip:: +I should be install with the pip method, otherwise install it manually:: sudo pip install timeside @@ -162,6 +162,7 @@ Set the app lists as follow:: 'django.contrib.messages', 'django.contrib.admin', 'telemeta', + 'timeside', 'jsonrpc', 'south' ) @@ -264,6 +265,7 @@ This synchronizes the DB with the model:: If you want tu use the data schema migration system (South needed, see previous paragraph):: ./manage.py migrate telemeta + ./manage.py collectstatic Start the project diff --git a/README.rst b/README.rst index 37f73510..e29cb8e5 100644 --- a/README.rst +++ b/README.rst @@ -2,18 +2,17 @@ Telemeta: open web audio CMS ============================= -For personal or collaborative media archiving projects, -research laboratories and digital humanities. +For personal or collaborative media archiving projects, research laboratories and digital humanities. -Based on Django, Python, full DHTML, CSS and JavaScript. +Based on Django, Python, HTML5, CSS and JavaScript. -Introduction -============ +Overview +========= Telemeta is a free and open source web audio archiving software 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 organize, backup and publish documented sound collections of audio files, CDs, digitalized vinyls and magnetic tapes over a strong database, in accordance with open web standards. -Main features: +Key features: * Secure archiving, editing and publishing of audio files over internet. * Pure HTML web user interface including dynamical forms and smart workflows @@ -29,11 +28,12 @@ Main features: * OAI-PMH data provider * RSS feed generators * XML serialized backup - * Strong SQL or Oracle backend + * SQLite, MySQL, PostgreSQL or Oracle DB backends * Multi-language support (now english and french) * Video support (EXPERIMENTAL, WebM only) -This web audio CMS is exclusively based on open source modules and can be run on any Unix or Linux system. It is mostly written in Python and JavaScript. +This web audio CMS is exclusively based on open source modules and can be run on any Unix or Linux system. +It is mostly written in Python and JavaScript. Installation, upgrade and usage @@ -45,6 +45,15 @@ See `INSTALL.rst `_ a News ====== +1.4.4 ++++++ + + * no new fancy functions + * full using of static files which are now in static/ (htdocs/ is now deprecated) + * IMPORTANT : update TimeSide to 0.4.1 and do: ./manage.py collectstatic + * add various buttons, various bugfixes + * after upgrading, always do: ./manage.py migrate + 1.4.3 ++++++ @@ -97,7 +106,7 @@ For developers and maintainers: ./manage.py syncdb ./manage.py migrate telemeta -See INSTALL.rst and email me if any pb! (you may, for example, not use 0002 migration) +See INSTALL.rst and email me if any pb! Full changelog: see `CHANGELOG `_ @@ -111,16 +120,26 @@ login: demo password: demo -Original Example +Original Examples ================= -`Sound archives `_ of the French Ethnomusicology Research Center (CREM) et du Musée de l'Homme: +`Sound archives of the French Ethnomusicology Research Center (CREM) and the Musée de l'Homme `_ : * a 100 year old world database migrated, * more than 5000 geolocated collections, * more than 32000 geolocated items, + * more than 11000 sounds included * 700 Go of original ethnological music files accessible through the web. +`Sound archives of the team "Lutherie, Acoustique et Musique" (LAM) of the IJLRDA institute - University Pierre et Marie Curie (Paris 6) `_ : + + * various musical instruments recorded for research purposes + * started in sept. 2012 + +`Sound archives Parisson `_ : + + * various electronic sounds and original electronic music produced by Parisson + Bugs and feedback ================= @@ -137,10 +156,9 @@ And even if Telemeta suits you, please give us some feedback ! Related projects ================ -`TimeSide `_ - Web Audio Components - - a python library library to compute audio analysis, transcode, and streaming to browsers. +`TimeSide `_ - open and fast web audio components + a python library to compute audio analysis, transcode, and streaming to browsers. Contact @@ -158,17 +176,23 @@ Twitter: * http://twitter.com/telemeta * http://twitter.com/parisson_studio - + * http://twitter.com/yomguy Development =========== You are welcome to participate to the development of the Telemeta project. +The official project site is `telemeta.org `_ but you can find a mirror on `GitHub `_. -To get the lastest development version, you need subversion and run:: +To get the lastest development version, you need Git and run:: $ git clone http://vcs.parisson.com/git/telemeta.git +or:: + + $ git clone git://github.com/yomguy/Telemeta.git + + License ======= -- 2.39.5