X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=INSTALL;h=4b052d80776dccff368e97cdf212301b21d3fe6b;hb=8e6a74ec22d4d313ba94fca4c8aa2d7f8f6a78ae;hp=e69de29bb2d1d6434b8b29ae775ad8c2e48c5391;hpb=12422fe0b1726327a63e0f0c6ecdbb62486ed902;p=vlc

diff --git a/INSTALL b/INSTALL
index e69de29bb2..4b052d8077 100644
--- a/INSTALL
+++ b/INSTALL
@@ -0,0 +1,67 @@
+$Id$
+
+INSTALL file for the VLC media player
+
+More extensive information for *nix, Windows, Mac OS X and BeOS users can be found here: 
+http://developers.videolan.org/vlc/
+
+Bootstrapping VLC
+=================
+
+If you retrieved VLC from the SVN server and do not have a "configure"
+script, please refer to the HACKING file.
+
+Configuring VLC
+===============
+
+A typical way to configure VLC is:
+
+   ./configure --prefix=/usr --enable-wxwindows
+
+See `./configure --help' for more information.
+
+If you intend to debug stuff, you may want to compile with debugging
+symbols:
+
+   make distclean ; ./configure --prefix=/usr --enable-wxwindows --enable-debug
+
+
+Building VLC
+============
+
+Have a look at the generated Makefile.opts file, you may want to choose
+which modules will be compiled as plugins, and which ones will remain in
+the core application. The configure script tries to guess for you.
+
+Once configured, run `make' to build VLC.
+
+
+Installing and running VLC
+==========================
+
+You can install the VLC and its plugins by typing:
+
+   make install
+
+But you don't need to install it if you don't want to; VLC can be launched
+from the current directory as well:
+
+   ./vlc
+
+
+Building packages
+=================
+
+To build a Debian package, you may use:
+
+   dpkg-buildpackage -rfakeroot -us -uc
+
+
+To build RedHat packages, use:
+
+   rpm -ba vlc.spec
+
+To build an ipkg package (iPAQ familiar Linux), use:
+
+   ipkg-buildpackage
+