]> git.parisson.com Git - teleforma.git/commitdiff
update doc
authoryomguy <yomguy@parisson.com>
Wed, 19 Sep 2012 19:53:42 +0000 (21:53 +0200)
committeryomguy <yomguy@parisson.com>
Wed, 19 Sep 2012 19:53:42 +0000 (21:53 +0200)
AUTHORS [new file with mode: 0644]
MANIFEST.in
README.rst
setup.py

diff --git a/AUTHORS b/AUTHORS
new file mode 100644 (file)
index 0000000..6b192a7
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1 @@
+Guillaume Pellerin <yomguy@parisson.com>
index 3c16c51791c3325aca54c162c5810eb6ded72dbb..0372526b97b73f93da0c0d4be328ee6a2b854e8b 100644 (file)
@@ -2,13 +2,10 @@ include AUTHORS
 include LICENSE
 include CHANGELOG
 include README.rst
-include INSTALL.rst
 exclude *.cfg
-recursive-include doc *
 recursive-include example *
-recursive-include telecampus/locale *
-recursive-include telecampus/templates *
-recursive-include telecampus/htdocs *
+recursive-include teleforma/templates *
+recursive-include telecampus/static *
 recursive-include telecampus/pages *
 global-exclude *.pyc
 prune dist
index dba1826650a0eeb54f012223ab96dc346d1bbfc2..62ea824e70b5a43b74b9194f8e7b069ca8e0dc73 100644 (file)
@@ -1,13 +1,28 @@
-=========
-TeleForma
-=========
+=========================================
+TeleForma : open web e-learning platform
+==========================================
 
-Teleforma is an open source web e-learning platform.
+Key features
+============
 
-keywords: social e-learning, live conferencing, hypermedia private access
+ * 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)
 
 It is based on Django and fully written in Python, HTML5, CSS and JavaScript.
 
+keywords: social e-learning, live conferencing, hypermedia private access
+
+Screenshot
+==========
+
+https://picasaweb.google.com/lh/photo/ZAvNjz2Hm4L9IHoWM5625tMTjNZETYmyPJy0liipFm0?feat=directlink
+
+
 News
 ====
 
@@ -17,18 +32,6 @@ News
  * First release! see the features ;)
 
 
-Key features
-============
-
- * 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)
-
-
 Installation
 ============
 
@@ -36,10 +39,10 @@ Teleforma is exclusively based on open-source modules.
 
 The best way to get in run and test is to install it in a virtualenv with pip::
 
-    sudo apt-get install python-pip python-gst0.10
-    sudo pip install virtualenv
-    virtualenv --system-site-packages teleforma
-    bin/pip install teleforma
+    sudo apt-get install python-pip python-gst0.10
+    sudo pip install virtualenv
+    virtualenv --system-site-packages teleforma
+    bin/pip install teleforma
 
 
 Demo
@@ -57,7 +60,7 @@ 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/yomguy/teleforma/issues
 
 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 !
@@ -66,40 +69,34 @@ And even if Telemeta suits you, please give us some feedback !
 Related projects
 ================
 
-`TimeSide <http://code.google.com/p/timeside/>`_ - Web Audio Components
-
-    a python library library to compute audio analysis, transcode, and streaming to browsers.
-
+ * `Telemeta <http://telemeta.org>`_ - open web audio CMS
+ * `TimeSide <http://code.google.com/p/timeside/>`_ - open web audio components
 
 
 Contact
 =======
 
-Homepage: http://telemeta.org
-
-E-mails:
+Homepage : https://github.com/yomguy/teleforma
 
- * Guillaume Pellerin <yomguy@parisson.com>,
- * Olivier Guilyardi <olivier@samalyse.com>,
- * Riccardo Zaccarelli <riccardo.zaccarelli@gmail.com>
+E-mail : Guillaume Pellerin <yomguy@parisson.com>
 
-Twitter:
+Twitter : http://twitter.com/parisson_studio
 
- * http://twitter.com/telemeta
- * http://twitter.com/parisson_studio
+Google+ : +Parisson
 
 
 Development
 ===========
 
-You are welcome to participate to the development of the Telemeta project.
+You are welcome to participate to the development of the TeleForma project.
+
+To get the lastest development version, you need git and run::
 
-To get the lastest development version, you need subversion and run::
+    $ git clone git://github.com/yomguy/teleforma.git
 
-    $ git clone http://vcs.parisson.com/git/telemeta.git
 
 License
 =======
 
-CeCILL v2, compatible with GPL v2 (see `LICENSE <http://github.com/yomguy/Telemeta/blob/master/LICENSE>`_)
+CeCILL v2, compatible with GPL v2 (see `LICENSE <https://github.com/yomguy/teleforma/blob/master/LICENSE>`_)
 
index e7a8ab809b5783bb02cfe94cfa185d18b6f5c114..e1d62c8ba2d8d1426cd23dcfd2be0bc38df7474c 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -6,8 +6,8 @@ CLASSIFIERS = ['Environment :: Web Environment', 'Framework :: Django', 'Intende
 
 setup(
   name = "TeleForma",
-  url = "http://parisson.com",
-  description = "open web multimedia e-learning system",
+  url = "https://github.com/yomguy/teleforma",
+  description = "open web multimedia e-learning platform",
   long_description = open('README.rst').read(),
   author = "Guillaume Pellerin",
   author_email = "yomguy@parisson.com",