From a9abf63ff6145613be4ed31af75bce3ae043b59c Mon Sep 17 00:00:00 2001 From: yomguy Date: Wed, 19 Sep 2012 21:32:28 +0200 Subject: [PATCH] fix readme --- README.rst | 151 +++++++++++++++++------------------------------------ 1 file changed, 48 insertions(+), 103 deletions(-) diff --git a/README.rst b/README.rst index e3d58a3b..dba18266 100644 --- a/README.rst +++ b/README.rst @@ -1,110 +1,54 @@ -============================= -Telemeta: open web audio CMS -============================= +========= +TeleForma +========= -For personal or collaborative media archiving projects, -research laboratories and digital humanities. +Teleforma is an open source web e-learning platform. -Based on Django, Python, full DHTML, CSS and JavaScript. - - -Introduction -============ - -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: - - * Secure archiving, editing and publishing of audio files over internet. - * Pure HTML web user interface including dynamical forms and smart workflows - * Smart dynamical and skinnable audio player (thanks to TimeSide and SoundManager2) - * "On the fly" audio analyzing, transcoding and metadata embedding based on an easy plugin architecture - * Social cumulative indexing with semantic ontologies and timecoded markers - * Multi-format support : FLAC, OGG, MP3, WAV and more - * User management with individual desk, lists, profiles and rights - * Playlist management for all users with CSV data export - * Geo-Navigator for audio geolocalization - * High level search engine - * DublinCore compatibility - * OAI-PMH data provider - * RSS feed generators - * XML serialized backup - * Strong SQL or Oracle backend - * 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. - - -Installation, upgrade and usage -================================ - -See `INSTALL.rst `_ and `telemeta.org `_ for more informations. +keywords: social e-learning, live conferencing, hypermedia private access +It is based on Django and fully written in Python, HTML5, CSS and JavaScript. News -====== +==== -1.4.2 -++++++ +0.8 ++++++ - * add user revisions to user profile - * move all edit buttons to main edit pages - * new Format object and various enumerations - * add last revision to item detail - * various bugfixes + * First release! see the features ;) -1.4.1 -++++++ - Fix a bug for related media title parsing +Key features +============ -1.4 -++++++ + * User management and registration + * School data model (trainings, courses, course types, professors, etc...) + * Video and audio LIVE conferencing (with TeleCaster devices) + * Media streaming and document management of various types + * Live chat room auto-creation for every conference created + * Embedded messaging system + * Media analyzing and indexing (thanks to Telemeta) -For users: - * add a Desk providing links to home and personal data - * add Fonds, Corpus and their related media to the models and to the search engine - * add some fancy drop down menus for main tabs - * add video media handling (WebM formats only and with the last TimeSide master branch) - * add playlist metadata editor - * fix some sad bugs for YouTube related URLs and previews - * cleanup admin page - * add auto saving now for all searches ! - * add "My Searches" modules to user lists with search direct link - * add RSS feeds for last changes of all users - * better icon views - * many bugfixes ! +Installation +============ -For developers and maintainers: +Teleforma is exclusively based on open-source modules. - * a new setting parameter: TELEMETA_DOWNLOAD_FORMATS = ('wav', 'mp3', 'webm') or whatever - * before upgrading, you need to BACKUP and manually delete old wrong MediaCorpus and MediaCorpusRelated tables - * we now use South for data model migration. Add 'south' to your apps and to do:: +The best way to get in run and test is to install it in a virtualenv with pip:: - ./manage.py syncdb - ./manage.py migrate telemeta + $ sudo apt-get install python-pip python-gst0.10 + $ sudo pip install virtualenv + $ virtualenv --system-site-packages teleforma + $ bin/pip install teleforma -See INSTALL.rst and email me if any pb! (you may, for example, not use 0002 migration) -Full changelog : see `CHANGELOG `_ +Demo +==== +http://teleforma.parisson.com -Development -=========== - -To participate to the development of telemeta, you will need a login/password couple. -You're welcome to email us to join and commit your great ideas ;) - -To get the lastest development version, you need subversion and run:: - - $ git clone http://vcs.parisson.com/git/telemeta.git - -License -======= - -CeCILL v2 (see LICENSE) +login: demo +password: demo Bugs and feedback @@ -122,7 +66,10 @@ And even if Telemeta suits you, please give us some feedback ! Related projects ================ -TimeSide (Web Audio Components): http://code.google.com/p/timeside/ +`TimeSide `_ - Web Audio Components + + a python library library to compute audio analysis, transcode, and streaming to browsers. + Contact @@ -142,19 +89,17 @@ Twitter: * http://twitter.com/parisson_studio -Sponsors -======== +Development +=========== + +You are welcome to participate to the development of the Telemeta project. + +To get the lastest development version, you need subversion and run:: + + $ git clone http://vcs.parisson.com/git/telemeta.git + +License +======= -The Telemeta project is developed by Parisson. It is sponsored by : +CeCILL v2, compatible with GPL v2 (see `LICENSE `_) - * CNRS : Centre National de la Recherche Scientifique (the french Natianal Research and Scientific Center) - http://cnrs.fr - * CREM : Centre de Recherche en Ethnomusicology (the french Ethnomusicology Research Center) - http://www.crem-cnrs.fr - * LAM : Equipe Lutherie, Acoustique et Musique de l'Université Pierre et Marie Curie de Paris - (Instrument design, Acoustic and Music team of the Pierre & Marie Curie University) - http://www.lam.jussieu.fr/ - * MuCEM : Musée des Civilisations de l'Europe et de la Méditerranée - http://www.musee-europemediterranee.org - * MMSH : Maison Méditerranéenne des Sciences de l'Homme - http://www.mmsh.univ-aix.fr/ -- 2.39.5