config file for doxygen
[cinelerra_cv/ct.git] / README.BUILD
blobbc6ea944972614d0b668db33b6c5e251f6f8e771
1 ----------------------------
2 Library Requirements:
3 ----------------------------
5 Whilst the official version of Cinelerra (Cinelerra-HV) contain a
6 custom Makefile, and includes many of the libraries in it, the
7 community version (Cinelerra-CV) is designed to to customly define the
8 Makefile specific for your system and use libraries that are / can be
9 installed into your system as shared libraries.
11 You need automake version 1.7 to build.  1.4 won't work!
12 Autoconf 2.57 is also required to build.
14 The automake version of the cinelerra source tree needs third-party libraries
15 development files installed. Run 'autoreconf -i' to create configure and
16 supporting files.
18         <x86 CPUs only>
19 You probably want to enable MMX support.  To do that, run ./configure with
20 the --enable-mmx option.  NB! If you do that, you may have to use the
21 --without-pic option, too.  Otherwise, compilation can fail.
22         </x86 CPUs only>
24 For debian user, you can find debian packages of all of these libs on the distribution
25 itself or at 
26         deb ftp://ftp.nerim.net/debian-marillat/ unstable main
28 (For other architectures/versions of Debian, more info can be found on:
29 http://hpisi.nerim.net/)
31 The versions indicated are for information. Cinelerra compiles fine
32 with these. If you want to use another, don't mail me if it doesn't work.
34 Some of them are part of every distribution (if they aren't in yours, change
35 you distrib. Not joking):
36         - a52dec
37         - alsa libs (>= 0.9)
38         - faac
39         - faad2
40         - fftw
41         - lame
42         - libavc1394
43         - libiec61883
44         - libraw1394
45         - libsndfile
46         - libvorbis (1.0)
47         - libogg (1.0)
48         - libpng
49         - libjpeg       
50         - libtiff
51         - libesd (esound = 0.2.28)
52         - libfreetype (>=2.1.4)
53         - mjpegtools
54         - OpenEXR
55         - x264
56         - xlib-dev
57         - gettext
59 Additional requirements for the CVS branch (this source code)
60         - automake 1.7
61         - autoconf
62         - libtool
63                 
64 The others are maybe part of your distrib. If they aren't, 
65 you can find most of them on ftp://ftp.nerim.net/debian-marillat/
66 and the rest on http://www.kiberpipa.org/~minmax/cinelerra/builds/
67 (if not, please complain to cinelerra@skolelinux.no!)
69 ----------------------------
70 Compiler flags:
71 ----------------------------
73 Note that there are some compiler flags that may optimise the
74 build for your specific architecture.  Some common examples are:
77 Pentium-M:
79 ./configure --prefix=/usr --enable-x86 --enable-mmx --enable-freetype2 \ 
80             --with-buildinfo=svn/recompile \
81  CFLAGS='-O3 -pipe -fomit-frame-pointer -funroll-all-loops -falign-loops=2 \
82          -falign-jumps=2 -falign-functions=2 -ffast-math \
83          -march=pentium-m -mfpmath=sse,387 -mmmx -msse'
85 Pentium 4: (include sth D, etc)
88 AMD 64:
91 ----------------------------
92 configure flags:
93 ----------------------------
95 For stamping builds:
96   --with-buildinfo=svn
97   --with-buildinfo=git
98      stamp the About dialog and version info with svn/git version,
99      [unsure] flag, and build date
100 --with-buildinfo=svn/recompile
101 --with-buildinfo=git/recompile
102      as above, but pull the version from svn/git every time make is run.
103 --with-buildinfo=cust/"SVN r980 SUSE"
104      Use a custom string to take the about dialog and version info,
105      for pacakgers who use 'make dist' and run configure on the resulting
106      tar file.