Replace gnulib patch with new common helper macro.

[gob-dx.git] / README

diff --git a/README b/README
index cb1c740ef9b22ed2fa7ee05edfe738cb62f41911..4792d54c59e40e884a0ba61b75df13ff3557f9e4 100644 (file)
--- a/README
+++ b/README
@@ -1,52 +1,68 @@
-GTK+ Object Builder (GOB)
+GObject Builder (GOB-2)
+(George's Obfuscated Bits)

 
 

-Very simple preprocessor for making GTK+ objects with inline C code so that
+Very simple preprocessor for making GObject 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
 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

-       - Writing a fully featured GTK+ object is a hassle
+       - Writing a fully featured GObject object is a hassle

        - Need for a generator that doesn't require changes to generated code
        - I like how Java writes method code directly into the class
          definition.
        - Need for a generator that doesn't require changes to generated code
        - I like how Java writes method code directly into the class
          definition.

+       - Perhaps there is less of a need for GOB now that Vala is around.
+         Still, GOB is simpler and more 'lightweight' if that matters.
+         IMO, Vala is a nicer long term solution.  But that doesn't mean
+         that GOB needs to (nor will) go away.

 
 To build:
        (the usual drill :)
        run "./configure;make"
 
 To install:
 
 To build:
        (the usual drill :)
        run "./configure;make"
 
 To install:

-       run "make install" as root, or just take the gob binary and place
+       run "make install" as root, or just take the gob2 binary and place

        it anywhere you want.
 
 To use:
        it anywhere you want.
 
 To use:

-       run gob with the .gob file on the command line
+       run gob2 with the .gob file on the command line

 
 What's generated:
        two (.c and .h) files named by the object name with words
        separated by a hyphen (not neccessairly the .gob file prefix)
 
 How to write .gob files?
 
 What's generated:
        two (.c and .h) files named by the object name with words
        separated by a hyphen (not neccessairly the .gob file prefix)
 
 How to write .gob files?

-       1) read "man gob" for some documenation on how to use GOB
+       1) read "man gob2" 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)
 
        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:
+How to include gob2 inside your project:

 
 

-       Put the gob distribution into a subdirectory in your main
+       Put the gob2 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
        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
+       inside your configure script in fact) so that gob2 doesn't install
+       itself.  Then just use the made gob2 binary as you would other

        preprocessors.
 
        preprocessors.
 

+License:
+       - Gob itself is under GPL, the generated code is under public domain.
+         See COPYING and COPYING.generated-code
+

 TODO:
        - clean up code
        - make it behave nice
        - add warnings all over the place
 TODO:
        - clean up code
        - make it behave nice
        - add warnings all over the place

-       - get a life
+       - get a life (done, hence the lower rate of updates to gob!)

 
 George <jirka@5z.com>
 
 George <jirka@5z.com>

+
+[
+  Note: if you are looking for the old GOB (for GTK+ objects), which is what
+  used to be here, look into the gob-1-0 branch in old gnome CVS!  It is
+  not maintained anymore.
+]
+