Start with git helper scripts and extra documentation

1 files changed, 36 insertions, 0 deletions

diff --git a/doc/README b/doc/README
new file mode 100644
index 0000000..3cf3dd7
--- /dev/null
+++ b/doc/README
@@ -0,0 +1,36 @@
+ODB is an object-relational mapping (ORM) system for C++. It provides
+tools, APIs, and library support that allow you to persist C++ objects
+to a relational database (RDBMS) without having to deal with tables,
+columns, or SQL and without manually writing any of the mapping code.
+For more information see:
+
+http://www.codesynthesis.com/products/odb/
+
+This package contains the pre-compiled binary distribution of the ODB
+compiler. The top-level directory structure of this package is as
+follows:
+
+bin/          ODB compiler binary
+doc/          ODB system documentation
+man/          man pages for the ODB compiler
+<arch>-<os>/  GCC compiler binaries, see manifest inside for details
+
+To install this package simply unpack it into a directory of your choice,
+for example /opt/. You can run the ODB compiler by either using the
+absolute path, for example:
+
+/opt/odb-x.y.z-i686-linux-gnu/bin/odb --version
+
+Or you can add the bin/ directory to the PATH environment variable, for
+example:
+
+export PATH=/opt/odb-x.y.z-i686-linux-gnu/bin:$PATH
+odb --version
+
+Note also that while you can move the ODB compiler directory around, you
+cannot move individual sub-directories or files inside it. For example,
+copying or linking the ODB compiler executable to /usr/local/bin/ will
+not work.
+
+Send questions, bug reports, or any other feedback to the 
+odb-users@codesynthesis.com mailing list.