X-Git-Url: http://developer.intra2net.com/git/?p=libt2n;a=blobdiff_plain;f=codegen%2FREADME;h=5c05067df0225d2b2d2999b7cbb62dbac39570de;hp=f5ef75646ebbf7441e2eb64080969ebf09a728ea;hb=7781f1c4d69c5be72d5cc98bf34d0b5ccf1f372e;hpb=e50cc1d69c0f69e431af2b4eac683ee3c5e35e68

diff --git a/codegen/README b/codegen/README
index f5ef756..5c05067 100644
--- a/codegen/README
+++ b/codegen/README
@@ -1 +1,17 @@
 code generator using gccxml and libxml++
+
+for example usage take a look at the libt2n-example package
+
+design decisions:
+
+installation of codegen-stubhead.hxx:
+codegen-stubhead.hxx is installed because the generated includes depend on the libt2n headers anyway
+
+make file snippet moved into libt2n-example1 and must be copied manually:
+automake is run first (before configure) and needs the makefile snippet => no way to let configure
+find the makefile snippet
+
+examples in separate packages:
+- this was done to be able to test that installation and configure scripts work as intended
+- there are two examples because one is used to generate the usage example documentation using doxygen
+  and one is used for automatic testing