Add docs.

Tue, 17 Feb 2009 00:23:00 +0000

author
nrich@ii.net
date
Tue, 17 Feb 2009 00:23:00 +0000
changeset 29
9b9d85320bc3
parent 28
44b1d78b50f5
child 30
8599f34c139b

Add docs.

INSTALL file | annotate | diff | comparison | revisions
README file | annotate | diff | comparison | revisions
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/INSTALL	Tue Feb 17 00:23:00 2009 +0000
@@ -0,0 +1,36 @@
+= Dependencies =
+
+Before attempting to build LuaDBI the development libaries for each database
+must be installed. For Debian/Ubuntu systems, the list of required dependancies
+are:
+ 
+ * libsqlite3-dev
+ * libmysqlclient15-dev
+ * libpq-dev
+ * db2exc (optional for DB2 support)
+ * oracle-xe-client (optional for Oracle support)
+  
+= Building =
+
+Run `make` (or `make free`) in the source directory to build the Open Source 
+database drivers. To build the drivers for DB2 and Oracle, run `make all`. 
+
+== Windows ==
+
+LuaDBI has not been built or tested on Windows.
+
+= Make Targets =
+
+ * make free - builds MySQL, PostgreSQL and SQLite3 drivers
+ * make all - as above, but also builds DB2 and Oracle drivers
+ * make mysql
+ * make psql
+ * make sqlite3
+ * make db2
+ * make oracle
+
+= Installation =
+
+Please consult your distributions documentation on installing Lua modules.
+Please note that both the database binary driver packages (*.so) and DBI.lua
+must be installed correctly to use LuaDBI
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Tue Feb 17 00:23:00 2009 +0000
@@ -0,0 +1,1 @@
+Please visit http://code.google.com/p/luadbi/w/list for details on using LuaDBI

mercurial