Update domain name to kpe.io
[clsql.git] / README
1 CLSQL is a Common Lisp to SQL engine interface by Kevin M.
2 Rosenberg. It includes both functional and object oriented subsystems
3 for data definition and manipulation as well as an integrated symbolic
4 SQL syntax.
5
6 CLSQL supports a number of RDBMS and uses the UFFI (http://uffi.kpe.io)
7 library for compatibility with Allegro CL, Lispworks, CMUCL, SBCL and
8 OpenMCL.
9
10 CLSQL has incorporated code from the following projects. At this point
11 in 2004, development of has stopped on these incorporated projects.
12   - Pierre Mai's MaiSQL
13   - onShore Development's UncommonSQL
14   - Paul Meurer's SQL/ODBC
15   - Cadabra's Oracle interface
16
17 CLSQL's home is http://clsql.kpe.io.
18
19 Documentation is available as a PDF file in doc/clsql.pdf and as HTML
20 files in doc/html.tar.gz.
21
22
23 CONTRIBUTING
24 ------------
25
26 If you would like to report a bug please do so through the clsql
27 mailing list. http://lists.kpe.io/mailman/listinfo/CLSQL
28
29 Patches are welcome. It will be much easier for us to incorporate if
30 you use [git](http://git-scm.com/). Please keep distinct changes in
31 seperate patches as it makes it much easier to review. If you have
32 something small to to send to the mailing list `git format-patch` is
33 your friend.
34
35 If you have a bigger set of patches then I recommend creating a fork
36 on github from https://github.com/UnwashedMeme/clsql. Once your
37 patches are available there either issue a pull request or let us know
38 about it on the mailing list.
39
40 * http://help.github.com/ has some excellent tutorials on getting
41   started.
42 * http://git-scm.com/book is an excellent in depth tutorial on how to
43   use git effectively.