b8c4a87c76b6ed25b287074361f87f0b05ac2f2b
[flac.git] / README
1 ==========
2 FLAC - 0.2
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         build/     makefile templates for building
18         doc/       the HTML documentation
19         include/   public include files for libFLAC
20         obj/       the compiled libraries and executables will
21                    end up here
22         src/       the source code and private headers
23         test/      the test scripts
24
25
26 =============================
27 Building in a GNU environment
28 =============================
29
30 All files called 'Makefile' are GNUmake files.  To build all
31 libraries and programs, just 'make all' from the top-level
32 directory.  To run the tests, just 'make test'.
33
34 Everything can be built in either debug or release mode.
35 See the Makefiles for details.
36
37
38 ==================
39 Building with MSVC
40 ==================
41
42 There is no overall make system for MSVC but the individual
43 source directories with a 'Makefile.vc' file in them allow
44 building with MSVC.  Just 'nmake /f Makefile.vc'.