From 7a5a2341f85026e654692b79820a0d953ce7f459 Mon Sep 17 00:00:00 2001 From: yomguy Date: Thu, 5 Jan 2012 12:59:21 +0100 Subject: [PATCH] fix doc --- README | 53 ------------------------------------------- INSTALL => README.rst | 36 +++++++++++++++++++++-------- 2 files changed, 26 insertions(+), 63 deletions(-) delete mode 100644 README rename INSTALL => README.rst (82%) diff --git a/README b/README deleted file mode 100644 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 - - -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/INSTALL b/README.rst similarity index 82% rename from INSTALL rename to README.rst index ac25e21..bb5a936 100644 --- a/INSTALL +++ b/README.rst @@ -1,10 +1,26 @@ -================== + +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) @@ -12,7 +28,7 @@ or Ubuntu / Kubuntu (>= 10.4). So please install one of these OS before. 2. Install dependencies -======================= +------------------------- Needed:: @@ -39,7 +55,7 @@ Uncomment:: 3. Install TeleCaster -===================== +---------------------- Untar the archive. For example:: @@ -52,7 +68,7 @@ Run the install script:: 4. Configuration -================ +------------------ Edit the following files to setup TeleCaster. Please be careful with the XML syntax:: @@ -65,7 +81,7 @@ and, ONLY if needed:: 5. Start audio deamons -====================== +------------------------ Just reboot your machine or start the deamons manually:: @@ -74,7 +90,7 @@ Just reboot your machine or start the deamons manually:: 6. Configure Apache2 -==================== +---------------------- Configure your apache VirtualHost editing /etc/apache2/sites-available/telecaster.conf @@ -92,7 +108,7 @@ Reload Apache:: 7. Usage -======== +---------- Browse the TeleCaster web control page: @@ -106,11 +122,11 @@ To change the form options, just edit the conf file as root:: 8. Contact -========== +------------ Any questions, suggestions ? Please post a ticket on the dev platform: - http://svn.parisson.org/telecaster + https://github.com/yomguy/TeleCaster-CGI or contact the main developer: -- 2.39.5