]> git.sesse.net Git - vlc/blob - INSTALL
Merge branch 'master' into lpcm_encoder
[vlc] / INSTALL
1 INSTALL file for the VLC media player
2
3 More extensive information for *nix, Windows, Mac OS X and BeOS users can be
4 found here: http://developers.videolan.org/vlc/
5
6 Bootstrapping VLC
7 =================
8
9 If you retrieved VLC from the git server and do not have a "configure"
10 script, please refer to the HACKING file.
11
12 Configuring VLC
13 ===============
14
15 A typical way to configure VLC is:
16
17    ./configure
18
19 See `./configure --help' for more information.
20
21 If you intend to debug stuff, you may want to compile with debugging
22 symbols:
23
24    make distclean ; ./configure --enable-debug
25
26 We recommend using GCC to build VLC, though some people reported success
27 with the Intel C compiler (version 8) as well. GCC version 3.3 or higher is
28 required. On older systems (e.g. FreeBSD 4.x, BeOS), please select a more
29 recent version manually by setting the CC and CXX environment variables
30 appropriately while running the ./configure shell script.
31
32
33 Building VLC
34 ============
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 need to get the packaging info
56    git clone git://git.debian.org/pkg-multimedia/vlc.git debian
57 and then
58    git-buildpackage
59
60
61 To build RPM packages, copy a spec file from extra/package/rpm and:
62
63    rpm -ba vlc.spec
64
65 To build an ipkg package (iPAQ familiar Linux), use:
66
67    ipkg-buildpackage
68