X-Git-Url: http://git.draconx.ca/gitweb/gob-dx.git/blobdiff_plain/b9f22ab5a7f4d4bfe0932debf8864a21b5c852cd..8cb6370effd9f2dacc6dc9b662a43ea19ee637ac:/README

diff --git a/README b/README
index 7ab5067..454ed59 100644
--- 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
+generatedfiles 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,11 @@ 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
 
 To use:
 	run gob with the .gob file on the command line
@@ -31,11 +30,20 @@ How to write .gob files?
 	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)
 
+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>