Working on documentation.

This commit is contained in:
Kyle Isom 2015-04-06 18:57:27 -07:00
parent 89c94158c2
commit 29fdec7e28
2 changed files with 116 additions and 0 deletions

62
doc/index.html Normal file
View File

@ -0,0 +1,62 @@
<?xml version="1.0"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>KUTILS: Kyle's utilities</title>
<link rel="stylesheet" type="text/css" href="style.css"/>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
</head>
<body>
<div class="header">
<h1>KUTILS</h1>
<h2>Kyle's utility package for Common Lisp development</h2>
</div>
<h3>Introduction</h3>
<p>This package contains utilities that I find useful in writing
programs; that is, it is a collection of generally-useful functions
and macros. Some of these I've written, and some of these derive from
other sources.</p>
<p>The utilities can be categorised as</p>
<ul>
<li>Those from <strong>On Lisp</strong>,</li>
<li>Those from <strong>Let Over Lambda</strong>,</li>
<li>The <code>hash-table</code> functions,</li>
<li>Miscellanea</li>
</ul>
<h3>On Lisp</h3>
<ul>
<li><code>mkstr</code>: concatenates its symbols and returns the printable representation
of the result</li>
</ul>
<h3>Quicklisp installation</h3>
<p>Clone into your Quicklisp project's <code>local-projects/</code>
subdirectory, and call <code>(ql:quickload :kutils)</code>.</p>
<h3>CVS</h3>
<p>You can <a
href="http://common-lisp.net/cgi-bin/viewcvs.cgi/?cvsroot=sample">
browse our CVS repository</a> or download the current development tree via
anonymous cvs, as described <a href="/faq.shtml">here</a></p>
<div class="footer">
<a href="mailto:kyle (at) metacircular (dot) net">K. Isom</a>, 2015-04-06.
</div>
<div class="check">
<a href="http://validator.w3.org/check/referer">
Valid XHTML 1.0 Strict</a>
</div>
</body>
</html>

54
doc/style.css Normal file
View File

@ -0,0 +1,54 @@
.header {
font-size: medium;
background-color:#336699;
color:#ffffff;
border-style:solid;
border-width: 5px;
border-color:#002244;
padding: 1mm 1mm 1mm 5mm;
}
.footer {
font-size: small;
font-style: italic;
text-align: right;
background-color:#336699;
color:#ffffff;
border-style:solid;
border-width: 2px;
border-color:#002244;
padding: 1mm 1mm 1mm 1mm;
}
.footer a:link {
font-weight:bold;
color:#ffffff;
text-decoration:underline;
}
.footer a:visited {
font-weight:bold;
color:#ffffff;
text-decoration:underline;
}
.footer a:hover {
font-weight:bold;
color:#002244;
text-decoration:underline; }
.check {font-size: x-small;
text-align:right;}
.check a:link { font-weight:bold;
color:#a0a0ff;
text-decoration:underline; }
.check a:visited { font-weight:bold;
color:#a0a0ff;
text-decoration:underline; }
.check a:hover { font-weight:bold;
color:#000000;
text-decoration:underline; }