* INSTALL: added reference to online info on compiling on MacOSX and BeOS

[vlc] / INSTALL

diff --git a/INSTALL b/INSTALL
index ba999911cc9e8f17685198d40964b0f4f18c4d1e..547718c4647a5a43c290807277ad0cc0a70148e1 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,49 +1,61 @@
-INSTALL file for vlc, the VideoLAN Client
+$Id: INSTALL,v 1.25 2003/03/19 15:44:44 hartman Exp $
 
+INSTALL file for the VLC media player
 
-Building VideoLAN
-=================
-
-A typical way to configure the vlc is :
+Mac OS X and BeOS users should read the documentation available at: 
+http://developers.videolan.org/vlc/
 
-   ./configure --prefix=/usr --enable-gnome --with-sdl
+Configuring VLC
+===============
 
-For a full compilation, you may try :
+A typical way to configure VLC is:
 
-   ./configure --prefix=/usr --enable-gnome --enable-fb \
-           --with-glide --with-ggi --with-sdl --enable-esd --enable-alsa
+   ./configure --prefix=/usr --enable-gnome
 
 See `./configure --help' for more information.
 
-Then, run `make', and `make install' to install it.
+If you intend to debug stuff, you may want to compile with debugging
+symbols:
 
+   make distclean ; ./configure --prefix=/usr --enable-gnome --enable-debug
 
-To build a Debian package, you may use :
 
-   dpkg-buildpackage -rfakeroot -us -uc
+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.
 
-To build RedHat packages, use :
+Once configured, run `make' to build VLC.
 
-   rpm -ba vlc.spec
 
+Installing and running VLC
+==========================
 
-Here's a shortcut to copy-paste to do a clean build :
+You can install the VLC and its plugins by typing:
 
-   make distclean 2>/dev/null ; ./configure --prefix=/usr --enable-gnome \
-      --enable-fb --with-glide --with-ggi --with-sdl --enable-esd \
-      --enable-alsa --enable-mga && make
+   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:
 
-Installing and running VideoLAN
-===============================
+   ./vlc
 
-You can install the vlc and its plugins by typing :
 
-   make install
+Building packages
+=================
 
-But you don't need to do it if you don't want ; vlc can be launched
-from the current directory as well :
+To build a Debian package, you may use:
 
-   ./vlc
+   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