X-Git-Url: http://git.draconx.ca/gitweb/gob-dx.git/blobdiff_plain/b9f22ab5a7f4d4bfe0932debf8864a21b5c852cd..486240dc4c5d57b0afaddba60d87fe375112bed5:/README diff --git a/README b/README index 7ab5067..cb1c740 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 +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 @@ -28,14 +28,25 @@ What's generated: 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 - make it behave nice - add warnings all over the place - - add autoconf/automake setup - get a life George