Release 0.91.1

[gob-dx.git] / README

diff --git a/README b/README
index b0637d89d0542d1eee0d4136aefd7ae30110edcf..c20e5ba9c895d4d5d0746928c2de3e527b141284 100644 (file)
--- a/README
+++ b/README
@@ -16,7 +16,8 @@ To build:
        run "./configure;make"
 
 To install:
        run "./configure;make"
 
 To install:

-       run "make install" as root
+       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
 
 To use:
        run gob with the .gob file on the command line


@@ -27,8 +28,20 @@ What's generated:
 
 How to write .gob files?
        1) read "man gob" for some documenation on how to use GOB
 
 How to write .gob files?
        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 and
-          src/lexer.l and src/parse.y (in other words: RTFS)
+       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
 
 TODO:
        - clean up code