diff options
author | Sergey Poznyakoff <gray@gnu.org.ua> | 2011-05-09 00:18:34 +0300 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org.ua> | 2011-05-09 00:18:34 +0300 |
commit | c9bb1bdfd12dce4d20375e6bd3bf6d41417191d8 (patch) | |
tree | 5039c88670bfa2596151ca467f75df7cec030503 /README.hacking | |
parent | e523423777dd75acc59cf7b9e7466527d774a9f9 (diff) | |
download | grecs-c9bb1bdfd12dce4d20375e6bd3bf6d41417191d8.tar.gz grecs-c9bb1bdfd12dce4d20375e6bd3bf6d41417191d8.tar.bz2 |
Write README files.
Diffstat (limited to 'README.hacking')
-rw-r--r-- | README.hacking | 93 |
1 files changed, 93 insertions, 0 deletions
diff --git a/README.hacking b/README.hacking new file mode 100644 index 0000000..56e0b12 --- /dev/null +++ b/README.hacking | |||
@@ -0,0 +1,93 @@ | |||
1 | Grecs README | ||
2 | Copyright (C) 2011 Sergey Poznyakoff | ||
3 | See the end of file for copying conditions. | ||
4 | |||
5 | * Introduction | ||
6 | |||
7 | This file provides information on how to build a standalone | ||
8 | version of Grecs from sources obtained from Git. | ||
9 | |||
10 | For information about the standalone version, see the file | ||
11 | README.standalone in this directory. | ||
12 | |||
13 | For a detailed description of Grecs, see the documentation in | ||
14 | the doc/ subdirectory, or visit http://grecs.man.gnu.org.ua. | ||
15 | |||
16 | * Overview | ||
17 | |||
18 | Grecs is a library for parsing structured configuration files from | ||
19 | C programs. A structured configuration file has hierarchical | ||
20 | structure, with block statements enclosing lower-level | ||
21 | statements. Such configurations files are used by many programs, such | ||
22 | as, e.g. Bind or Dico. | ||
23 | |||
24 | Grecs provides primitives for parsing such files into an internal | ||
25 | tree-like structure and for basic operations on such structures. These | ||
26 | operations include value lookups by keyword paths, traversing trees | ||
27 | recursively, joining several trees together, reductions, etc. | ||
28 | |||
29 | * Requirements | ||
30 | |||
31 | If you have taken the sources from GIT you will need the following | ||
32 | packages to build the standalone library. I don't make any extra | ||
33 | effort to accommodate older versions of these packages, so please make | ||
34 | sure that you have the latest stable version. | ||
35 | |||
36 | - Automake <http://www.gnu.org/software/automake/> | ||
37 | - Autoconf <http://www.gnu.org/software/autoconf/> | ||
38 | - Bison <http://www.gnu.org/software/bison/> | ||
39 | - Flex <http://flex.sourceforge.net/> | ||
40 | - M4 <http://www.gnu.org/software/m4/> | ||
41 | - Texinfo <http://www.gnu.org/software/texinfo> | ||
42 | |||
43 | * Bootstrapping | ||
44 | |||
45 | Obviously, if you are reading these notes, you did manage to check out | ||
46 | Grecs from GIT. The next step is to prepare the sources for standalone | ||
47 | build: | ||
48 | |||
49 | 1. Create a placeholder for ChangeLog file: | ||
50 | |||
51 | > ChangeLog | ||
52 | |||
53 | This file is needed for the bootstrap process. It will be replaced | ||
54 | with the actual ChangeLog after make. | ||
55 | |||
56 | 2. Similarly, provide a placeholder for README file: | ||
57 | |||
58 | > README | ||
59 | |||
60 | 3. Bootstrap the package: | ||
61 | |||
62 | autoreconf -f -i -s | ||
63 | |||
64 | 3. Configure and make: | ||
65 | |||
66 | ./configure | ||
67 | make | ||
68 | |||
69 | * Bug reporting. | ||
70 | |||
71 | Send bug reports to <gray+grecs@gnu.org.ua>. | ||
72 | |||
73 | |||
74 | * Copyright information: | ||
75 | |||
76 | Copyright (C) 2011 Sergey Poznyakoff | ||
77 | |||
78 | Permission is granted to anyone to make or distribute verbatim copies | ||
79 | of this document as received, in any medium, provided that the | ||
80 | copyright notice and this permission notice are preserved, | ||
81 | thus giving the recipient permission to redistribute in turn. | ||
82 | |||
83 | Permission is granted to distribute modified versions | ||
84 | of this document, or of portions of it, | ||
85 | under the above conditions, provided also that they | ||
86 | carry prominent notices stating who last changed them. | ||
87 | |||
88 | |||
89 | Local Variables: | ||
90 | mode: outline | ||
91 | paragraph-separate: "[ ]*$" | ||
92 | version-control: never | ||
93 | End: | ||