d3fe143aaaab084e628d491d6faa2899320c6d60
[flac.git] / README
1 ===========
2 FLAC - 0.10
3 ===========
4
5 This is the source release for the FLAC project.  The
6 reference encoder/decoder library 'libFLAC' is released
7 under the LGPL (see COPYING.LGPL).  This means the code
8 in include/FLAC/ and src/libFLAC/.  All other code is
9 covered by the GPL (see COPYING.GPL).  See
10
11         doc/index.html
12
13 for full documentation.
14
15 A brief description of the directory tree:
16
17         doc/       the HTML documentation
18         include/   public include files for libFLAC
19         src/       the source code and private headers
20         test/      the test scripts
21
22
23 =============================
24 Building in a GNU environment
25 =============================
26
27 FLAC now uses autoconf and libtool for configuring and
28 building.  Better documentation for these will be
29 forthcoming, but in general, this should work:
30
31 ./configure ; make ; make install
32
33 To disable all assembly optimizations, pass the
34 --disable-asm-optimizations flag to configure.
35
36
37 ==================
38 Building with MSVC
39 ==================
40
41 There is no overall make system for MSVC but the individual
42 source directories with a 'Makefile.vc' file in them allow
43 building with MSVC.  Just 'nmake /f Makefile.vc'.  Currently
44 the Makefile.vc for libFLAC is hardcoded to use nasm.  If
45 you don't have nasm, or don't want any assembly optimizations,
46 edit the makefile, adding '/D FLAC__NO_ASM' and delete the
47 rules which compile the .s files.