some basic info on how to use mvn added

[vlc] / bindings / java / README

diff --git a/bindings/java/README b/bindings/java/README
index 6f2d0f8d45c31fa3fdad8c5a7be5990ac3e2f990..231d8d23d4e651de97899a7580badcc173b02d78 100644 (file)
--- a/bindings/java/README
+++ b/bindings/java/README
@@ -2,37 +2,39 @@
             First of all, this is a *developers* only version
 
 
-Usage
------
+How to compile JVLC
+-------------------
 
- In order to use these bindings you have to compile vlc from source. I
-recommend you to take the latest version from videolan svn repository
-(or use at least revison 15823) by doing:
+ JVLC uses maven2 as a project the management tool, take a look at
 
-svn co svn://svn.videolan.org/vlc/trunk vlc-trunk
+http://maven.apache.org
 
- bootstrap, clean and configure:
+ to download and for general instructions on how to use it.
 
-./bootstrap && make distclean
-./configure --enable-java-bindings && make && make install
+ To compile the project, run from the bindings/java folder:
 
- If you give a prefix be sure to change the PREFIX variable in the Makefile
-from /usr/local to your prefix.
+mvn install
 
- Once you've done with vlc you can run make in jvlc directory. Be sure
-you have gcj, gcjh and if you want to use the SUN Java compiler,
-change the Makefile accordingly. You will probably need to change also 
+ To import the jvlc project into the eclipse IDE:
 
-JINCLUDES
-LIBJINCLUDES
+mvn eclipse:eclipse
 
- In the next releases I will automate this process.
+ and then import as an existing Java project.
 
- To run a Java VLC example issue:
 
-java -Djava.library.path=. VlcClient
+How to run the sample client
+----------------------------
+
+ 1. mvn install (in bindings/java)
+
+ 2. mvn package exec:java (in bindings/java/samples/client)
+
+
+How to create the jvlc site
+---------------------------
+
+ 1. mvn site
+
 
- Be sure your ldconfig can find libjawt.so and libmawt.so or you will
-get linking errors when you run the program.
 
  Happy playing.