[vlma-devel] commit: Update README. (Adrien Grand )

[git version control]

vlma | branch: master | Adrien Grand <jpountz at videolan.org> | Thu Jul 17 22:46:34 2008 +0200| [0d17d7c34a09221048a7e382b974d77d1315dfdf]

Update README.

A more user oriented README. Development tips should be in the wiki but not in this file.

> http://git.videolan.org/gitweb.cgi/vlma.git/?a=commit;h=0d17d7c34a09221048a7e382b974d77d1315dfdf
---

 README |   81 +++++++++------------------------------------------------------
 1 files changed, 12 insertions(+), 69 deletions(-)

diff --git a/README b/README
index f579625..d0cf249 100644
--- a/README
+++ b/README
@@ -1,75 +1,18 @@
 VLMa (VideoLAN Manager)
 =======================
 
-Disclaimer: This README is a developer only version.
+VLMa is an application which aims at providing an easy way to manage
+several servers running VLC at the same time. It consists of a daemon
+responsible for assigning orders to available servers and a web
+interface to manage configuration.
 
+VLMa is distributed under the terms of the GNU General Public Licence
+(GPL) version 2 or any later version. See COPYING.
 
-What is the VLMa?
------------------
+A typical use case is the streaming of satellite channels over a
+multicast network. However, VLMa can also help you stream files or TNT
+channels over a network that doesn't support multicast. For more
+information, have a look at:
+ * the official website: http://www.videolan.org/vlma
+ * VideoLAN wiki: http://wiki.videolan.org/VLMa
 
-The VLMa is a tool which aims at providing a web interface to manage
-several servers running VLC at the same time.
-
-
-How to compile
---------------
-
-Requirements:
- - JDK (version >= 5.0)
- - Maven2
-
-The VLMa uses Maven as a build system. If you are not familiar with
-this tool, take a look at http://maven.apache.org.
-
-To compile the project, run from the root folder:
-  % mvn install
-
-
-Try it !
---------
-
-To try the VLMa, run from the daemon folder:
-  % mvn compile exec:java
-
-and then run from the web folder:
-  % mvn jetty:run
-
-You sould now be able to access the web interface at
-http://localhost:8080.
-
-Have fun!
-
-
-Eclipse integration
--------------------
-
-If you wish to develop the VLMa within Eclipse, install a Maven2 Eclipe
-integration plugin like this one:
-http://m2eclipse.codehaus.org
-
-You can now import the project into Eclipse using the File > Import wizard.
-
-
-Eclipse compilation
--------------------
-
-Always compile the core first :
-In your workspace, click right on vlma-core directory, then on "Run As" and
-first on "Maven Clean" and secondly on "Maven Install". This should compile
-the core and install it into your local Maven repository.
-
-Compile and launch the daemon :
-Do the same as for the core for the vlma-daemon directory. "Maven Install"
-function will this time also run the daemon.
-
-Compile and launch the web aplication :
-Do again the same with the "vlma-web" directory.
-To launch the web application, you need to configure an external tools.
-To do that click on the menu "Run" then on "External Tools" and again on
-"External Tools". A window should appear.
-Create a new launch configuration in the "Maven Build" node of the tree.
-Name it "vlma-web". For the "Base directory", browse your file system to
-vlma-web directory. Type "jetty:run" in the "Goals" textbox.
-Finaly click on "Run" button.
-
-That's it : you have got a vlma devel version which runs !