* Update of README and install files with new information.
[vlc.git] / INSTALL
1 $Id$
2
3 INSTALL file for the VLC media player
4
5 More extensive information for *nix, Windows, Mac OS X and BeOS users can be found here: 
6 http://developers.videolan.org/vlc/
7
8 Bootstrapping VLC
9 =================
10
11 If you retrieved VLC from the SVN server and do not have a "configure"
12 script, please refer to the HACKING file.
13
14 Configuring VLC
15 ===============
16
17 A typical way to configure VLC is:
18
19    ./configure --prefix=/usr --enable-wxwindows
20
21 See `./configure --help' for more information.
22
23 If you intend to debug stuff, you may want to compile with debugging
24 symbols:
25
26    make distclean ; ./configure --prefix=/usr --enable-wxwindows --enable-debug
27
28
29 Building VLC
30 ============
31
32 Have a look at the generated Makefile.opts file, you may want to choose
33 which modules will be compiled as plugins, and which ones will remain in
34 the core application. The configure script tries to guess for you.
35
36 Once configured, run `make' to build VLC.
37
38
39 Installing and running VLC
40 ==========================
41
42 You can install the VLC and its plugins by typing:
43
44    make install
45
46 But you don't need to install it if you don't want to; VLC can be launched
47 from the current directory as well:
48
49    ./vlc
50
51
52 Building packages
53 =================
54
55 To build a Debian package, you may use:
56
57    dpkg-buildpackage -rfakeroot -us -uc
58
59
60 To build RedHat packages, use:
61
62    rpm -ba vlc.spec
63
64 To build an ipkg package (iPAQ familiar Linux), use:
65
66    ipkg-buildpackage
67