Commit c8c77b90 authored by Ryszard Szopa's avatar Ryszard Szopa

downloading and spellchecking

darcs-hash:d6ffc263bdf7bf6e2c45ac2e1fa45e4860053abe
parent bb415a59
......@@ -16,28 +16,36 @@
<p>Submarine is a Common Lisp library that's somewhere between a
PostgreSQL library an an object persistency system. It uses
Postmodern to communicate with the database. The basic idea is that
you create your classes in the metaclass DB-CLASS and submarine cares
about creating SQL tables or, if the tables already exist, checking if
they conform to the provided specification. Moreover, Submarine
supports an intuitive way of expressing both one-to-many and
many-to-many relations.</p>
<a href="http://common-lisp.net/project/postmodern">Postmodern</a> to
communicate with the database. The basic idea is that you create your
classes in the metaclass DB-CLASS and submarine cares about creating
SQL tables or, if the tables already exist, checking if they conform
to the provided specification. Moreover, Submarine supports an
intuitive way of expressing both one-to-many and many-to-many
relations.</p>
<h1>Table of contents</h1>
<ol>
<li><a href="#getting_submarine">Getting Submarine</a></li>
<li><a href="#dependencies">Dependencies</a></li>
<li><a href="#support_and_mailing_lists">Support and mailing lists</a></li>
<li><a href="#license">License</a></li>
<li><a href="#introduction_for_postmodern_users">Introduction for
Postmodern users</a></li>
<li><a href="#api_reference">API reference</a></li>
<li><a href="#quick_start">Quick start</a></li>
</ol>
<a name="getting_submarine"><h1>Getting submarine</h1></a>
<p>At the moment there's only a darcs repository available:</p>
<p>
You can download both <a href="submarine.tar.gz">Submarine</a>,
and <a href="mop-utils.tar.gz">MOP-utils</a> (a small library of MOP
related utilities on which Submarine depends). However, submarine
isn't very stable at the moment, so I strongly advise you to get the
newest version through darcs.
</p>
<code>
darcs get http://szopa.tasak.gda.pl/repos/submarine/
</code>
......@@ -48,6 +56,11 @@ submarine in the close future:
<code>
darcs get http://szopa.tasak.gda.pl/repos/mop-utils/
</code>
<p>In both cases (downloading the archive or getting it through darcs)
you will need to link the <code>.asd</code> files to some place
visible by <code>ASDF</code>.</p>
<p>I will make Submarine ASDF-installable soon.</p>
<a name="dependencies"><h1>Dependencies</h1></a>
......@@ -55,7 +68,15 @@ submarine in the close future:
library of MOP utilities, MOP-UTILS, which may become a separate
library in the future. On platforms other than SBCL, mop-utils needs
Closer-mop.</p>
<a name="support_and_mailing_lists">
<h1>Support and mailing lists</h1></a>
<p>The <a
href="http://common-lisp.net/mailman/listinfo/submarine-devel">submarine-devel</a>
mailing list can be used for questions, discussion, bug-reports,
patches, or anything else relating to this library. Or mail the
author/maintainer
directly: <a href="mailto:ryszard.szopa@gmail.com">Ryszard
Szopa</a>.</p>
<a name="license"><h1>License</h1></a>
<p>Submarine is released under a BSD-like license. Which approximately
......@@ -168,7 +189,7 @@ makes it easier to maintain and to extend.</li>
(:connection-spec "submarine-test" "richard" "dupa" "localhost"))
</pre>
</code>
<p>The aguments in the :connection-spec are the following: name of the
<p>The arguments in the :connection-spec are the following: name of the
database, name of the user, password, host. The user should be able
to create tables in the given database.</p>
<p>Let's macroexpand last form:</p>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment