]> git.parisson.com Git - telemeta.git/commitdiff
update docs
authorGuillaume Pellerin <yomguy@parisson.com>
Fri, 28 Nov 2014 02:30:54 +0000 (03:30 +0100)
committerGuillaume Pellerin <yomguy@parisson.com>
Fri, 28 Nov 2014 02:30:54 +0000 (03:30 +0100)
INSTALL.rst
README.rst
tools/dev/make_doc.sh

index 039009372f3a3b47ca239fb61be18dc048686a70..fb0518598e9ffdb98fe2e951e3427981badbfda8 100644 (file)
@@ -24,17 +24,6 @@ Telemeta is designed first to run on Linux platforms.
 
 * Windows plaforms are not officialy supported but possible.
 
-
-----------------
-Development
-----------------
-
-    sudo aptitude install git
-    git clone https://github.com/yomguy/Telemeta.git
-    cd Telemeta
-    sudo pip install -e .
-    export PYTHONPATH=$PYTHONPATH:`pwd`
-
 -------------------------
 Fast testing (sandbox)
 -------------------------
@@ -57,21 +46,20 @@ Start your project
 
 For example::
 
-    cd ~/my_projects
-    django-admin startproject mysite
+    cd ~/projects
+    django-admin startproject newproject
 
 Create the database
 ------------------------
 
-Telemeta needs MySQL to work well and fast. So you need to create a MySQL database before trying it.
-But you can also use SQLite, PostgreSQL or Oracle DB.
+Telemeta needs MySQL to work well and fast in production. So you need to create a MySQL database before trying it. But you can also use SQLite, PostgreSQL or Oracle DB.
 
-Configure the telemeta project
+Configure the project
 ----------------------------------
 
-Edit the file settings.py in a text editor. You can find (even copy) an example there::
+Edit the file newproject/settings.py in a text editor.
 
-    example/sandbox/settings.py
+You can find and even copy the example in the sandbox (example/sandbox/settings.py)
 
 Modifiy the following variables::
 
index 56427c0f5db2982af533e67bd6634965877c8096..3df1343aea3bc4af2bc0ac0b044133d52a16cec8 100644 (file)
@@ -6,6 +6,7 @@ Telemeta: open web audio app with semantics
 
 .. |travis_master| image:: https://secure.travis-ci.org/Parisson/Telemeta.png?branch=master
    :target: https://travis-ci.org/Parisson/Telemeta/
+   :alt: Travis
 
 .. |version| image:: https://pypip.in/version/Telemeta/badge.png
    :target: https://pypi.python.org/pypi/Telemeta/
@@ -15,8 +16,8 @@ Telemeta: open web audio app with semantics
    :target: https://pypi.python.org/pypi/Telemeta/
    :alt: Downloads
 
-.. |coverage| image:: https://coveralls.io/repos/Parisson/Telemeta/badge.png?branch=dev
-   :target: https://coveralls.io/r/Parisson/Telemeta?branch=dev
+.. |coverage| image:: https://coveralls.io/repos/Parisson/Telemeta/badge.png?branch=devmaster
+   :target: https://coveralls.io/r/Parisson/Telemeta?branch=master
    :alt: Coverage
 
 
@@ -51,12 +52,6 @@ It is mostly written in Python and JavaScript.
 The processing engine of Telemeta is a separate project called `TimeSide <https://github.com/yomguy/timeside/>`_ as an open web audio pocessing framework written in Python.
 
 
-Installation, upgrade and usage
-================================
-
-See `INSTALL.rst <http://github.com/yomguy/Telemeta/blob/master/INSTALL.rst>`_ and `telemeta.org <http://telemeta.org>`_ for more informations.
-
-
 News
 ======
 
@@ -64,10 +59,11 @@ News
 +++++
 
  * Compatible with Django 1.6.x
- * Huge refactor of all forms, detail and edit views
- * Main styles are now based Bootstrap 3.x
- * Update models thanks to the CREM needs
  * Compatible with TimeSide 0.6.x
+ * Huge refactor of all forms, detail and edit views
+ * Main styles (buttons, tabs) are now based Bootstrap 3 and JQuery 2.1
+ * Update models and views as needed by the CREM
+ * New depedencies
 
 1.4.6
 +++++
@@ -117,15 +113,57 @@ Serious Usecases
 * Various electronic sounds and original electronic music produced by Parisson
 
 
+Install
+=======
+
+See `INSTALL.rst <http://github.com/yomguy/Telemeta/blob/master/INSTALL.rst>`_ and `telemeta.org <http://telemeta.org>`_ for more informations.
+
+
+API / Documentation
+====================
+
+* Publications : https://github.com/Parisson/Telemeta-doc
+* API : http://files.parisson.com/doc/telemeta/
+* Player : https://github.com/Parisson/TimeSide/
+* Example : http://archives.crem-cnrs.fr/archives/items/CNRSMH_E_2004_017_001_01/
+
+
+Development
+===========
+
+|travis_dev| |coverage|
+
+.. |travis_dev| image:: https://secure.travis-ci.org/Parisson/Telemeta.png?branch=dev
+   :target: https://travis-ci.org/Parisson/Telemeta/
+   :alt: Travis
+
+.. |coverage_dev| image:: https://coveralls.io/repos/Parisson/Telemeta/badge.png?branch=dev
+   :target: https://coveralls.io/r/Parisson/Telemeta?branch=dev
+   :alt: Coverage
+
+
+You are welcome to participate to the development of the Telemeta project.
+The official project site is `telemeta.org <http://telemeta.org>`_ but you can find a mirror on `GitHub <https://github.com/Parisson/Telemeta>`_.
+
+To get and run the lastest development version::
+
+    sudo apt-get install git
+    git clone https://github.com/Parisson/Telemeta.git
+    cd Telemeta
+    sudo pip install -e .
+    export PYTHONPATH=$PYTHONPATH:`pwd`
+
+
 Bugs and feedback
 =================
 
 You are welcome to freely use this application in accordance with its licence.
 If you find some bugs, PLEASE leave a ticket on this page:
 
-http://telemeta.org/newticket
+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 <https://twitter.com/telemeta>`_.
 
-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 !
 
 
@@ -148,21 +186,6 @@ Twitter:
  * http://twitter.com/yomguy
 
 
-Development
-===========
-
-You are welcome to participate to the development of the Telemeta project.
-The official project site is `telemeta.org <http://telemeta.org>`_ but you can find a mirror on `GitHub <https://github.com/yomguy/Telemeta>`_.
-
-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
 =======
 
index 08eaf7374a977b0c241aef52402f90bc17a23b9c..4adac635b46d4aaa6bfcf5350c3cae8124ccf592 100755 (executable)
@@ -3,8 +3,8 @@
 
 app="telemeta"
 dir=/home/$USER/dev/$app/doc/
-server="angus.parisson.com"
+server="git.parisson.com"
 
-epydoc -n $app -u https://github.com/yomguy/Telemeta -o $dir $app/
+epydoc -n $app -u https://github.com/Parisson/Telemeta -o $dir $app/
 rsync -a $dir $server:/var/www/files/doc/$app/