]> git.donarmstrong.com Git - flightcrew.git/blob - README.txt
debian/patches/*: fix quilt-patch-missing-description lintian tag
[flightcrew.git] / README.txt
1 \r
2 FlightCrew is a C++, cross-platform, native code epub validator.\r
3 The version of the package can be found in the ChangeLog.txt file.\r
4 \r
5 It's website is located here: http://code.google.com/p/flightcrew/\r
6 \r
7 The src directory contains all of the source code. It has\r
8 a few subdirectories:\r
9     src/BoostParts - source code of various parts of the Boost C++ \r
10                      Libraries that FlightCrew uses;\r
11     src/FlightCrew - source code for the FlightCrew, the validation \r
12                      library;\r
13     src/FlightCrew-cli - the command-line front-end to the FlightCrew\r
14                          library; \r
15     src/FlightCrew-gui - the GUI front-end to the FlightCrew library;\r
16     src/googlemock - a framework used for the test suite\r
17     src/utf8-cpp - a header-only library for dealing with utf-8 in C++\r
18     src/Xerces - an XML parser\r
19     src/XercesExtensions - a library containing some common wrapper \r
20                            code for Xerces; this lib is part of FC\r
21     src/Zipios - a ZIP library\r
22     src/zlib - a lib for data compression (the DEFLATE algorithm)\r
23     \r
24 The entire public interface of the library can be accessed by including\r
25 the src/FlightCrew/flightcrew.h header file.\r
26 \r
27 The installer directory contains the files needed to produce\r
28 a binary installer for Windows and Linux.\r
29 \r
30 The INSTALL.txt file contains information on building FlightCrew \r
31 from source code (and installing it on Linux machines).\r
32 \r
33 The LGPLv3 license under which Sigil is released is located in\r
34 the file called COPYING.txt and COPYING.LESSER.txt.