summaryrefslogtreecommitdiffabout
path: root/README.hacking
authorSergey Poznyakoff <gray@gnu.org.ua>2011-05-08 21:18:34 (GMT)
committer Sergey Poznyakoff <gray@gnu.org.ua>2011-05-08 21:18:34 (GMT)
commitc9bb1bdfd12dce4d20375e6bd3bf6d41417191d8 (patch) (side-by-side diff)
tree5039c88670bfa2596151ca467f75df7cec030503 /README.hacking
parente523423777dd75acc59cf7b9e7466527d774a9f9 (diff)
downloadgrecs-c9bb1bdfd12dce4d20375e6bd3bf6d41417191d8.tar.gz
grecs-c9bb1bdfd12dce4d20375e6bd3bf6d41417191d8.tar.bz2
Write README files.
Diffstat (limited to 'README.hacking') (more/less context) (ignore whitespace changes)
-rw-r--r--README.hacking93
1 files changed, 93 insertions, 0 deletions
diff --git a/README.hacking b/README.hacking
new file mode 100644
index 0000000..56e0b12
--- a/dev/null
+++ b/README.hacking
@@ -0,0 +1,93 @@
+Grecs README
+Copyright (C) 2011 Sergey Poznyakoff
+See the end of file for copying conditions.
+
+* Introduction
+
+This file provides information on how to build a standalone
+version of Grecs from sources obtained from Git.
+
+For information about the standalone version, see the file
+README.standalone in this directory.
+
+For a detailed description of Grecs, see the documentation in
+the doc/ subdirectory, or visit http://grecs.man.gnu.org.ua.
+
+* Overview
+
+Grecs is a library for parsing structured configuration files from
+C programs. A structured configuration file has hierarchical
+structure, with block statements enclosing lower-level
+statements. Such configurations files are used by many programs, such
+as, e.g. Bind or Dico.
+
+Grecs provides primitives for parsing such files into an internal
+tree-like structure and for basic operations on such structures. These
+operations include value lookups by keyword paths, traversing trees
+recursively, joining several trees together, reductions, etc.
+
+* Requirements
+
+If you have taken the sources from GIT you will need the following
+packages to build the standalone library. I don't make any extra
+effort to accommodate older versions of these packages, so please make
+sure that you have the latest stable version.
+
+- Automake <http://www.gnu.org/software/automake/>
+- Autoconf <http://www.gnu.org/software/autoconf/>
+- Bison <http://www.gnu.org/software/bison/>
+- Flex <http://flex.sourceforge.net/>
+- M4 <http://www.gnu.org/software/m4/>
+- Texinfo <http://www.gnu.org/software/texinfo>
+
+* Bootstrapping
+
+Obviously, if you are reading these notes, you did manage to check out
+Grecs from GIT. The next step is to prepare the sources for standalone
+build:
+
+1. Create a placeholder for ChangeLog file:
+
+ > ChangeLog
+
+This file is needed for the bootstrap process. It will be replaced
+with the actual ChangeLog after make.
+
+2. Similarly, provide a placeholder for README file:
+
+ > README
+
+3. Bootstrap the package:
+
+ autoreconf -f -i -s
+
+3. Configure and make:
+
+ ./configure
+ make
+
+* Bug reporting.
+
+Send bug reports to <gray+grecs@gnu.org.ua>.
+
+
+* Copyright information:
+
+Copyright (C) 2011 Sergey Poznyakoff
+
+ Permission is granted to anyone to make or distribute verbatim copies
+ of this document as received, in any medium, provided that the
+ copyright notice and this permission notice are preserved,
+ thus giving the recipient permission to redistribute in turn.
+
+ Permission is granted to distribute modified versions
+ of this document, or of portions of it,
+ under the above conditions, provided also that they
+ carry prominent notices stating who last changed them.
+
+
+Local Variables:
+mode: outline
+paragraph-separate: "[ ]*$"
+version-control: never
+End:

Return to:

Send suggestions and report system problems to the System administrator.