README
1
2 HighlighterKit Framework README
3 *******************************
4
5 This package contains the source distribution of the HighlighterKit
6 framework. HighlighterKit is a framework to allow easy incorporation of
7 syntax highlighting features into your application.
8
9
10 INSTALLATION
11 ------------
12
13 You must install the GNUstep framework in order to be able to compile
14 and use HighlighterKit. After that use the following commands:
15
16 $ make
17 $ make install
18
19
20 DOCUMENTATION
21 -------------
22
23 The source code contains Doxygen documentation for all parts of the
24 framework and it's usage. To generate the documentation you need to
25 install Doxygen and then invoke the following command in the
26 framework's directory:
27
28 $ doxygen
29
30 This will generate docs in the Documentation subdirectory in HTML
31 format. To change the way documentation is generated (e.g. add more
32 types of output formats) edit the Doxyfile file.
33
34
35 AUTHORS (names encoded in UTF-8)
36 --------------------------------
37
38 Sašo Kiselkov <skiselkov@gmail.com>
39
40
41 LICENSE
42 -------
43
44 This framework and all it's components are released under the terms of
45 the GNU General Public License v2. The text of the license is included
46 in the file COPYING. Associated documentation is released the terms of
47 the GNU Free Documentation License v1.2 or any later. For the text of
48 GNU Free Documentation License please see the file COPYING.fdl.
49