From 1c6d5d4b6aea06554d6d3342262b8d551bf816fd Mon Sep 17 00:00:00 2001
From: Boris Kolpackov <boris@codesynthesis.com>
Date: Thu, 23 Sep 2010 13:37:38 +0200
Subject: README files for the examples

---
 hello/README   | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 hello/makefile |  5 +++--
 2 files changed, 55 insertions(+), 2 deletions(-)
 create mode 100644 hello/README

(limited to 'hello')

diff --git a/hello/README b/hello/README
new file mode 100644
index 0000000..97a15b4
--- /dev/null
+++ b/hello/README
@@ -0,0 +1,52 @@
+This is a "Hello World" example that shows how to use ODB to perform basic
+database operations, such as making objects persistent, loading, updating
+and deleting persistent objects, as well as querying the database for
+objects matching a certain criteria.
+
+The example consists of the following files:
+
+person.hxx
+  Header file defining the 'person' persistent class.
+
+person-odb.hxx
+person-odb.ixx
+person-odb.cxx 
+person.sql
+  The first three files contain the database support code and the last file
+  contains the database schema for the person.hxx header.
+
+  These files are generated by the ODB compiler from person.hxx using the
+  following command line:
+
+  odb -d <database> --generate-query --generate-schema person.hxx
+  
+  Where <database> stands for the database system we are using, for example,
+  'mysql'.
+
+database.hxx
+  Contains the create_database() function which instantiates the concrete
+  database class corresponding to the database system we are using.
+
+driver.cxx
+  Driver for the example. It includes the person.hxx and person-odb.hxx
+  headers to gain access to the 'person' class and the database support
+  code for this class. It also includes database.hxx for the 
+  create_database() function declaration.
+    
+  In main() the driver first calls create_database() to obtain the database
+  instance. Then it executes a number of database transactions on persistent
+  objects.
+
+To run the example we first need to create the database schema. Using MySQL
+as an example, this can be achieved with the following command:
+
+mysql --user=odb_test --database=odb_test < person.sql
+
+Here we use 'odb_test' as the database login and also 'odb_test' as the
+database name.
+
+Once the database schema is ready, we can run the example (using MySQL as
+the database):
+
+./driver --user odb_test --database odb_test
+
diff --git a/hello/makefile b/hello/makefile
index 8192aae..2d32e16 100644
--- a/hello/makefile
+++ b/hello/makefile
@@ -70,9 +70,10 @@ $(dist): sources := $(cxx_tun)
 $(dist): headers := $(odb_hdr)
 $(dist): export name := $(name)
 $(dist): export odb_header_stem := $(basename $(odb_hdr))
-$(dist): export extra_dist := $(call vc9projs,$(name)) $(call vc10projs,$(name))
+$(dist): export extra_dist := README $(call vc9projs,$(name)) \
+$(call vc10projs,$(name))
 $(dist):
-	$(call dist-data,$(sources) $(headers) database.hxx)
+	$(call dist-data,$(sources) $(headers) README database.hxx)
 	$(call meta-automake,../template/Makefile.am)
 	$(call meta-vc9projs,../template/template,$(name))
 	$(call meta-vc10projs,../template/template,$(name))
-- 
cgit v1.1