diff --git a/README.md b/README.md new file mode 100644 index 0000000..695ab75 --- /dev/null +++ b/README.md @@ -0,0 +1,86 @@ +DeforaOS libDatabase +==================== + +About libDatabase +----------------- + +libDatabase provides an abstraction layer for relational database management +systems (RDBMS) using SQL as the query language. + +libDatabase depends on the DeforaOS libSystem library (version 0.4.3 or above), +which is found on the website for the DeforaOS Project: +. + + +Compiling libDatabase +--------------------- + +libDatabase depends on the following components: + + * DeforaOS libSystem + * An implementation of `make` + * GTK-Doc for the API documentation + * PostgreSQL's client libraries + * SQLite 2 + * SQLite 3 + +With GCC, this should then be enough to compile and install libDatabase: + + $ make install + +To install libDatabase in a dedicated directory, like `/path/to/libDatabase`: + + $ make PREFIX="/path/to/libDatabase" install + + +Generating Makefiles +-------------------- + +If necessary, it is possible to re-generate the Makefiles for the current +platform with `configure(1)` from the DeforaOS configure project, found at +. The procedure is then as +follows: + + $ configure + $ make + +Please refer to the documentation of DeforaOS configure for further +instructions. + +THe Makefiles provided target the NetBSD Operating System + by default. + + +Python bindings +--------------- + +Part of libDatabase's API can also be accessed from within the Python +programming language. This binding is not compiled or installed by default. +After installing libDatabase as documented above, the Python interface can be +built and installed as follows: + + $ (cd src/python && make install) + +Likewise, an alternate installation directory may be specified: + + $ (cd src/python && make PREFIX="/path/to/libDatabase" install) + +Makefiles can be re-generated for the bindings as well: + + $ configure src/python + + +Distributing libDatabase +------------------------ + +DeforaOS libDatabase is subject to the terms of the 2-clause BSD license. +Please see the `COPYING` file for more information. + + +Caveats +------- + +### Python bindings + +The Python bindings are outdated and still assume Python 2.7. + diff --git a/project.conf b/project.conf index 3f989d5..af74993 100644 --- a/project.conf +++ b/project.conf @@ -4,7 +4,7 @@ config=ent,h,sh subdirs=data,doc,include,src,tests,tools targets=tests -dist=COPYING,Makefile,config.ent,config.h,config.sh +dist=COPYING,Makefile,README.md,config.ent,config.h,config.sh #targets [tests] @@ -17,3 +17,6 @@ phony=1 #dist [COPYING] install=$(PREFIX)/share/doc/$(PACKAGE) + +[README.md] +install=$(PREFIX)/share/doc/$(PACKAGE)