Release 1.0.2

[gob-dx.git] / README

diff --git a/README b/README
index 3c3d0027188a022343831ef7ee54b04ddbf092c8..cb1c740ef9b22ed2fa7ee05edfe738cb62f41911 100644 (file)
--- a/README
+++ b/README
@@ -1,9 +1,8 @@
 GTK+ Object Builder (GOB)
 
-Very early prototype. An extremely poor attempt at making a lex or yacc like
-preprocessor for making GTK+ objects, while keeping he language in a sort of
-java like style, and keeping the implementation extremely simple and without
-having to parse any real C code.
+Very simple preprocessor for making GTK+ objects with inline C code so that
+generated files are not editted.  Syntax is inspired by java and yacc or lex.
+The implementation is intentionaly kept simple, and no C code parsing is done.
 
 Reasons:
        - C is a perfect (well mostly) language, no need for another language
@@ -13,11 +12,12 @@ Reasons:
          definition.
 
 To build:
-       run make
+       (the usual drill :)
+       run "./configure;make"
 
 To install:
-       edit the makefile to edit the destination directory and run
-       "make install" as root (or just put src/gob somewhere nice)
+       run "make install" as root, or just take the gob binary and place
+       it anywhere you want.
 
 To use:
        run gob with the .gob file on the command line
@@ -27,16 +27,26 @@ What's generated:
        separated by a hyphen (not neccessairly the .gob file prefix)
 
 How to write .gob files?
-       1) read doc/USER_GUIDE for some documenation on how to use
-          GOB
-       2) if you can't find what you need, read src/test.gob and
-          src/lexer.l and src/parse.y (in other words: RTFS)
+       1) read "man gob" for some documenation on how to use GOB
+       2) if you can't find what you need, read src/test.gob for an
+          example of GOB code
+       3) If you still can't find what you need, read src/lexer.l
+          and src/parse.y (in other words: RTFS)
+
+How to include gob inside your project:
+
+       Put the gob distribution into a subdirectory in your main
+       project directory.  Use the AC_CONFIG_SUBDIRS to include that
+       directory in your configure run.  And finally add a file called
+       NOINST_GOB into your toplevel project directory (this can be done
+       inside your configure script in fact) so that gob doesn't install
+       itself.  Then just use the made gob binary as you would other
+       preprocessors.
 
 TODO:
        - clean up code
        - make it behave nice
        - add warnings all over the place
-       - add autoconf/automake setup
        - get a life
 
 George <jirka@5z.com>