]> git.parisson.com Git - telecaster-cgi.git/commitdiff
fix doc
authoryomguy <yomguy@parisson.com>
Thu, 5 Jan 2012 11:59:21 +0000 (12:59 +0100)
committeryomguy <yomguy@parisson.com>
Thu, 5 Jan 2012 11:59:21 +0000 (12:59 +0100)
INSTALL [deleted file]
README [deleted file]
README.rst [new file with mode: 0644]

diff --git a/INSTALL b/INSTALL
deleted file mode 100644 (file)
index ac25e21..0000000
--- a/INSTALL
+++ /dev/null
@@ -1,117 +0,0 @@
-==================
-INSTALL TeleCaster
-==================
-
-
-1. Operating System
-===================
-
-TeleCaster now only works on GNU/Linux systems. The installer and the following instructions
-are based on Debian like software management so that it should work on Debian (>= Lenny) 
-or Ubuntu / Kubuntu (>= 10.4). So please install one of these OS before.
-
-
-2. Install dependencies
-=======================
-
-Needed::
-
-    sudo aptitude update
-
-    sudo aptitude install python python-dev python-xml python-libxml2 python-setuptools python-twitter python-liblo python-mutagen \
-                        icecast2 apache2 apache2-suexec jackd libjack-dev vorbis-tools procps meterbridge fluxbox \
-                        vnc4server vncviewer swh-plugins jack-rack libshout3 libshout3-dev libmad0-dev libogg-dev g++
-
-Warning: on Debian Squeeze or recent Ubuntu, change libjack-dev to libjack-jackd2-dev
-
-Optional::
-
-    sudo aptitude install libfaac-dev libmp3lame-dev libflac-dev 
-
-Note that obtaining and installing a preempt RT kernel is STRONGLY advised to get a good audio (JACK) stability.
-Moreover, edit the pam conf file to get RT "su" pam limits at boot::
-    
-    sudo vi /etc/pam.d/su
-    
-Uncomment::
-    
-    session    required   pam_limits.so
-
-
-3. Install TeleCaster
-=====================
-
-Untar the archive. For example::
-    
-    tar xzf telecaster-0.5.tar.gz
-    
-Run the install script::
-    
-    cd telecaster-0.5/
-    sudo python install.py
-
-
-4. Configuration
-================
-
-Edit the following files to setup TeleCaster. Please be careful with the XML syntax::
-
-    /etc/telecaster/telecaster.xml
-
-and, ONLY if needed::
-
-    /etc/default/jackd
-    /etc/default/vncserver
-
-
-5. Start audio deamons
-======================
-
-Just reboot your machine or start the deamons manually:: 
-
-    sudo /etc/init.d/jackd start
-    sudo /etc/init.d/vncserver start
-
-
-6. Configure Apache2
-====================
-
-Configure your apache VirtualHost editing /etc/apache2/sites-available/telecaster.conf
-
-Enable the VirtualHost::
-    
-    sudo a2ensite telecaster.conf
-    
-Maybe remove the default VirtualHost::
-    
-    sudo rm /etc/apache2/sites-enabled/000-default
-
-Reload Apache::
-
-    sudo /etc/init.d/apache2 reload
-
-
-7. Usage 
-========
-
-Browse the TeleCaster web control page:
-
-    http://localhost/telecaster/telecaster.py
-
-Fill in the form and start any free recording and broadcasting stream !
-
-To change the form options, just edit the conf file as root::
-    
-    sudo vi /etc/telecaster/telecaster.xml
-    
-
-8. Contact
-==========
-
-Any questions, suggestions ? Please post a ticket on the dev platform:
-    
-    http://svn.parisson.org/telecaster
-
-or contact the main developer:
-
-    Guillaume Pellerin <yomguy@parisson.com>
diff --git a/README b/README
deleted file mode 100644 (file)
index ef673f0..0000000
--- a/README
+++ /dev/null
@@ -1,53 +0,0 @@
-===================
-README - TELECASTER
-===================
-
-TeleCaster is a web controlled audio/video recording and braodcasting system.
-
-
-LICENCE
-=======
-
-# This software is a computer program whose purpose is to stream audio
-# and video data through icecast2 servers with a web based frontend.
-
-# This software is governed by the CeCILL  license under French law and
-# abiding by the rules of distribution of free software.  You can  use,
-# modify and/ or redistribute the software under the terms of the CeCILL
-# license as circulated by CEA, CNRS and INRIA at the following URL
-# "http://www.cecill.info".
-
-# As a counterpart to the access to the source code and  rights to copy,
-# modify and redistribute granted by the license, users are provided only
-# with a limited warranty  and the software's author,  the holder of the
-# economic rights,  and the successive licensors  have only  limited
-# liability.
-
-# In this respect, the user's attention is drawn to the risks associated
-# with loading,  using,  modifying and/or developing or reproducing the
-# software by the user in light of its specific status of free software,
-# that may mean  that it is complicated to manipulate,  and  that  also
-# therefore means  that it is reserved for developers  and  experienced
-# professionals having in-depth computer knowledge. Users are therefore
-# encouraged to load and test the software's suitability as regards their
-# requirements in conditions enabling the security of their systems and/or
-# data to be ensured and,  more generally, to use and operate it in the
-# same conditions as regards security.
-
-# The fact that you are presently reading this means that you have had
-# knowledge of the CeCILL license and that you accept its terms.
-
-# Author: Guillaume Pellerin <yomguy@parisson.com>
-
-
-ARCHITECTURE
-============
-Build and install well on Debian (>= Lenny) or Ubuntu/Kubuntu (>= 10.04)
-
-
-MORE INFOS
-==========
-
-See http://svn.parisson.org/telecaster/
-See http://svn.parisson.org/deefuzzer/
-
diff --git a/README.rst b/README.rst
new file mode 100644 (file)
index 0000000..bb5a936
--- /dev/null
@@ -0,0 +1,133 @@
+
+TeleCaster is a web controlled audio/video recording and broadcasting system.
+It is written in python and freely available for Linux.
+
+
+ARCHITECTURE
+============
+Build and install well on Debian (>= Lenny) or Ubuntu/Kubuntu (>= 10.10)
+
+
+MORE INFOS
+==========
+
+GitHub: https://github.com/yomguy/TeleCaster-CGI
+Twitter : @parisson_studio
+
+
+INSTALL TeleCaster
+==================
+
+
+1. Operating System
+--------------------
+
+TeleCaster now only works on GNU/Linux systems. The installer and the following instructions
+are based on Debian like software management so that it should work on Debian (>= Lenny) 
+or Ubuntu / Kubuntu (>= 10.4). So please install one of these OS before.
+
+
+2. Install dependencies
+-------------------------
+
+Needed::
+
+    sudo aptitude update
+
+    sudo aptitude install python python-dev python-xml python-libxml2 python-setuptools python-twitter python-liblo python-mutagen \
+                        icecast2 apache2 apache2-suexec jackd libjack-dev vorbis-tools procps meterbridge fluxbox \
+                        vnc4server vncviewer swh-plugins jack-rack libshout3 libshout3-dev libmad0-dev libogg-dev g++
+
+Warning: on Debian Squeeze or recent Ubuntu, change libjack-dev to libjack-jackd2-dev
+
+Optional::
+
+    sudo aptitude install libfaac-dev libmp3lame-dev libflac-dev 
+
+Note that obtaining and installing a preempt RT kernel is STRONGLY advised to get a good audio (JACK) stability.
+Moreover, edit the pam conf file to get RT "su" pam limits at boot::
+    
+    sudo vi /etc/pam.d/su
+    
+Uncomment::
+    
+    session    required   pam_limits.so
+
+
+3. Install TeleCaster
+----------------------
+
+Untar the archive. For example::
+    
+    tar xzf telecaster-0.5.tar.gz
+    
+Run the install script::
+    
+    cd telecaster-0.5/
+    sudo python install.py
+
+
+4. Configuration
+------------------
+
+Edit the following files to setup TeleCaster. Please be careful with the XML syntax::
+
+    /etc/telecaster/telecaster.xml
+
+and, ONLY if needed::
+
+    /etc/default/jackd
+    /etc/default/vncserver
+
+
+5. Start audio deamons
+------------------------
+
+Just reboot your machine or start the deamons manually:: 
+
+    sudo /etc/init.d/jackd start
+    sudo /etc/init.d/vncserver start
+
+
+6. Configure Apache2
+----------------------
+
+Configure your apache VirtualHost editing /etc/apache2/sites-available/telecaster.conf
+
+Enable the VirtualHost::
+    
+    sudo a2ensite telecaster.conf
+    
+Maybe remove the default VirtualHost::
+    
+    sudo rm /etc/apache2/sites-enabled/000-default
+
+Reload Apache::
+
+    sudo /etc/init.d/apache2 reload
+
+
+7. Usage 
+----------
+
+Browse the TeleCaster web control page:
+
+    http://localhost/telecaster/telecaster.py
+
+Fill in the form and start any free recording and broadcasting stream !
+
+To change the form options, just edit the conf file as root::
+    
+    sudo vi /etc/telecaster/telecaster.xml
+    
+
+8. Contact
+------------
+
+Any questions, suggestions ? Please post a ticket on the dev platform:
+    
+    https://github.com/yomguy/TeleCaster-CGI
+
+or contact the main developer:
+
+    Guillaume Pellerin <yomguy@parisson.com>