From 349991c06944aefd3babbc4e6758b99af00a2f9b Mon Sep 17 00:00:00 2001 From: Guillaume Pellerin Date: Sun, 3 Apr 2016 01:35:13 +0200 Subject: [PATCH] fix doc --- README.rst | 44 +++++++++++++++++++++++++------------------- 1 file changed, 25 insertions(+), 19 deletions(-) diff --git a/README.rst b/README.rst index 9df7496c..d459013f 100644 --- a/README.rst +++ b/README.rst @@ -75,10 +75,11 @@ News Telemeta is now usable on any OS, ready for development and for production use cases in 5 mn! B-) * Provide a docker image and composition for the full Telemeta application bundle. -* Install new useful tools and modules : Conda, Jupyter notebook, +* Install new useful tools like Conda, Jupyter notebook and many other modules. * Full refactoring of the search engine and interface using django-haystack and ElasticSearch with new faceting and smart filtering features * Add an automatic EPUB3 ebook exporter for corpus and collections embedding metadata, image and audio materials. * Upgrade of every dependency bundle in the composition +* Switch to Affero GPL licence * Many, many bugfixes * Thanks to all partners for this **huge** release! @@ -145,6 +146,12 @@ To start the application in DEBUG mode:: docker-compose -f docker-compose.yml -f env/debug.yml up +Be **CAREFULL** in production: + + * The database is deleted when using `docker-compose rm` + * Define your own passwords and secret keys in env/*.env files + * Use a cron rule and the backup script to save your work periodically + Backup / Restore ================ @@ -193,25 +200,22 @@ To start the application in a development environment setup:: git checkout dev docker-compose -f docker-compose.yml -f env/dev.yml up -Then browse the app at http://localhost:9000/ (replacing 'localhost' by the IP given by the docker terminal on OSX or Windows) - -You are welcome to participate to the development by forking the Telemeta project on `GitHub `_. +Then browse the app at http://localhost:9000/ (replacing 'localhost' by the IP given by the docker terminal on OSX or Windows). Note the service will automatically when code is modified. -To build your own composition:: +To build your own composition (if dependency tree is changed):: docker-compose -f docker-compose.yml -f env/dev.yml -f env/build.yml build +You are welcome to participate to the development by forking the Telemeta project on `GitHub `_. + Bugs, issues, ideas =================== -If you find some bugs or have good ideas for enhancement, please leave a issue on GitHub with the right label: - -https://github.com/Parisson/Telemeta/issues/new - -You can also leave some ticket to request some new interesting features for the next versions and tweet your ideas to `@telemeta `_. +If you find some bugs or have good ideas for enhancement, please leave a `issue on GitHub `_ with the right label or tweet it tweet it @telemeta_. -And remember: even if Telemeta suits you, please give us some feedback ! +And remember: even if Telemeta suits you, please give us some feedback. We **need** your support! License @@ -234,23 +238,24 @@ Sponsors and partners * CREM_ : Centre de Recherche en Ethnomusicologie (Ethnomusicology Research Center) * LAM_ : Equipe Lutherie, Acoustique et Musique de l'IJLRDA_ * IJLRDA_ : Institut Jean le Rond d'Alembert (Paris, France) - * Parisson_ : Open audio development agency for science and arts (Paris, France) + * Parisson_ : Open development agency for audio science and arts (Paris, France) * MNHN_ : Museum National d'Histoire Naturelle (National Museum of Biology, Paris, France) - * U-Paris10_ : University Paris Oues Nanterre (Paris 10, France) + * UPMC_ : University Pierre et Marie Curie (Paris 6, Sorbonne Universités) + * U-Paris10_ : University Paris Ouest Nanterre (Paris 10, France) * MuseeDelHomme_ : Musée de l'Homme (Paris, France) * LIMSI_ : Laboratoire d'Informatique pour la Mécanique et les Sciences de l'Ingénieur * LABRI_ : Laboratoire Bordelais de Recherche en Informatique + * C4DM_ : Centre for Digital Music at `Queen Mary University`_ (London, UK) * HumaNum_ : TGIR des humanités numériques * IRCAM_ : Institut de Recherche et de Coordination Acoustique / Musique (Paris, France) - * QMUL_ : `Centre for Digital Music`_ of Queen Mary University (London, UK) Related research projects ========================== * DIADEMS_ : Description, Indexation, Access to Sound and Ethnomusicological Documents, funded by the French Research Agency (ANR_ CONTINT 2012), involving IRIT_, CREM_, LAM_, LABRI_, LIMSI_, MNHN_, Parisson_ -* TimeSide-DIADEMS_ : a set of Timeside plugins developed during the DIADEMS_ project -* +* TimeSide-DIADEMS_ : a set of Timeside plugins for hich level music analysis developed during the DIADEMS_ project +* SoundSoftware_ : Sustainable Software of Audio and Music Research * DaCaRyH_ : Le rythme calypso à travers l’histoire : une approche en sciences des données (AHRC_ “Care for the Future” et le Labex-Passé_Présent_ "Les passés dans le présent") * Kamoulox_ : Démixage en ligne de larges archives sonores (ANR_ Jeune Chercheur 2015) * WASABI_ : Web Audio Semantic Aggregated in the Browser for Indexation (ANR_ 2016, currently submitted) @@ -290,6 +295,7 @@ Related research projects .. _DaCaRyH: http://archives.crem-cnrs.fr/archives/fonds/CNRSMH_DACARYH/ .. _Kamoulox: http://www.agence-nationale-recherche.fr/?Projet=ANR-15-CE38-0003 .. _AHRC: http://www.ahrc.ac.uk/ -.. _QMUL: http://www.qmul.ac.uk/ -.. _SoundSofware : http://soundsoftware.ac.uk/ -.. _Centre for Digital Music: http://c4dm.eecs.qmul.ac.uk/ +.. _Queen Mary University: http://www.qmul.ac.uk/ +.. _SoundSoftware : http://soundsoftware.ac.uk/ +.. _C4DM: http://c4dm.eecs.qmul.ac.uk/ +.. _@telemeta: https://twitter.com/telemeta -- 2.39.5