added readme for example-codegen
[libt2n] / examples-codegen / README
diff --git a/examples-codegen/README b/examples-codegen/README
new file mode 100644 (file)
index 0000000..57d2ce2
--- /dev/null
@@ -0,0 +1,10 @@
+Examples using the code generator.
+
+example1* are  simple  examples also  used for the  doxygen  generated
+documentation.
+
+example2* are more complex examples used for automatic testing.
+
+Those  examples  have  to be  build   separately. Take  a  look at the
+test-build-install-use script in  the top level directory to  automate
+this task.