X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=INSTALL;h=6cc19066cf88f071c9de526db819a0212a26fdb3;hb=12ade3e3bc975d5426ba4af155b7372c31093b31;hp=e69de29bb2d1d6434b8b29ae775ad8c2e48c5391;hpb=12422fe0b1726327a63e0f0c6ecdbb62486ed902;p=vlc

diff --git a/INSTALL b/INSTALL
index e69de29bb2..6cc19066cf 100644
--- a/INSTALL
+++ b/INSTALL
@@ -0,0 +1,68 @@
+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 git server and do not have a "configure"
+script, please refer to the HACKING file.
+
+Configuring VLC
+===============
+
+A typical way to configure VLC is:
+
+   ./configure
+
+See `./configure --help' for more information.
+
+If you intend to debug stuff, you may want to compile with debugging
+symbols:
+
+   make distclean ; ./configure --enable-debug
+
+We recommend using GCC to build VLC, though some people reported success
+with the Intel C compiler (version 8) as well. GCC version 3.3 or higher is
+required. On older systems (e.g. FreeBSD 4.x, BeOS), please select a more
+recent version manually by setting the CC and CXX environment variables
+appropriately while running the ./configure shell script.
+
+
+Building VLC
+============
+
+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 need to get the packaging info
+   git clone git://git.debian.org/pkg-multimedia/vlc.git debian
+and then
+   git-buildpackage
+
+
+To build RPM packages, copy a spec file from extra/package/rpm and:
+
+   rpm -ba vlc.spec
+
+To build an ipkg package (iPAQ familiar Linux), use:
+
+   ipkg-buildpackage
+