Also ship and install a README file
This commit is contained in:
parent
818effabbc
commit
c2af37329c
86
README.md
Normal file
86
README.md
Normal file
|
@ -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:
|
||||
<https://www.defora.org/>.
|
||||
|
||||
|
||||
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
|
||||
<https://www.defora.org/os/project/16/configure>. 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
|
||||
<https://www.netbsd.org/> 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.
|
||||
|
|
@ -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)
|
||||
|
|
Loading…
Reference in New Issue
Block a user