s/wxwindows/wxwidgets/
[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-wxwidgets
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-wxwidgets --enable-debug
27
28 We recommend using GCC (versions 3.3 or later) to build VLC, though some
29 people reported success with the Intel C compiler (version 8) as well. As of
30 VLC version 0.9.0, GCC 2.95 is not supported anymore; if this is the default
31 compiler on your system (e.g. FreeBSD 4.x), please select a more recent
32 version manually by setting the CC and CXX environment variables
33 appropriately while running the ./configure shell script.
34
35
36 Building VLC
37 ============
38
39 Have a look at the generated Makefile.opts file, you may want to choose
40 which modules will be compiled as plugins, and which ones will remain in
41 the core application. The configure script tries to guess for you.
42
43 Once configured, run `make' to build VLC.
44
45
46 Installing and running VLC
47 ==========================
48
49 You can install the VLC and its plugins by typing:
50
51    make install
52
53 But you don't need to install it if you don't want to; VLC can be launched
54 from the current directory as well:
55
56    ./vlc
57
58
59 Building packages
60 =================
61
62 To build a Debian package, you need to get the packaging info
63    svn co svn://svn.videolan.org/pkg-multimedia/unstable/vlc/debian debian 
64 and then
65    dpkg-buildpackage -rfakeroot -us -uc
66
67
68 To build RedHat packages, use:
69
70    rpm -ba vlc.spec
71
72 To build an ipkg package (iPAQ familiar Linux), use:
73
74    ipkg-buildpackage
75