--- /dev/null
+;;; -*- Mode: Lisp -*-
+
+(in-package :lml)
+
+(page readme
+ (head
+ (title "LML README")
+ (meta-key :http-equiv "Content-Type" :content "text/html; charset=iso-8859-1")
+ (meta "Copyright" "Kevin Rosenberg 2002 <kevin@rosenberg.net>")
+ (meta "description" "Lisp Markup Language Documentation")
+ (meta "author" "Kevin Rosenberg")
+ (meta "keywords" "Common Lisp, HTML, Markup Langauge"))
+
+ (body
+ (h1 "LML Documentation")
+ (h2 "Overview")
+ (p "LML is a Common Lisp package for generating HTML and XHTML documents. "
+ "LML is authored by "
+ (a :href "mailto:kevin@rosenberg.net" "Kevin Rosenberg") ". "
+ "The home page for LML is "
+ (a :href "http://lml.b9.com/" "http://www.b9.com/") ".")
+
+ (h2 "Installation")
+ (p "The easiest way to install LML is to use the "
+ (a :href "http://www.debian.org/" "Debian")
+ " GNU/Linux operating system. You can then use the command "
+ (tt "apt-get install cl-lml")
+ " to automatically download and install the LML package.")
+ (p "On a non-Debian system, you need to have either "
+ (a :href "http://cclan.sourceforge.net/" "ASDF") " or "
+ (a :href "http://www.sourceforge.net/clocc/" "mk-defsystem")
+ " installed to load the system definition file. You will need to change the source "
+ "pathname in the system file to match the location where you have installed LML.")
+
+ (h2 "Usage")
+ (p "Currently, there is no documentation on the functions provided by LML. "
+ "However, the source code is instructive and there are example files included "
+ "in the LML package.")
+
+ (h2 "Examples")
+ (table
+ (tbody :border 1
+ (tr
+ (td :colspan 2 :style "color:000;background-color:ccc;font-weight:bold;" "Iteration"))
+ (tr
+ (td
+ (pre
+"\"The square of the first five integers are\"
+ (loop as x from 1 to 5
+ doing
+ (lml-print \" ~D\" (* x x)))"))
+ (td
+ (loop as x from 1 to 5
+ doing
+ (lml-print " ~D" (* x x)))))
+ ))))
projects / lml.git / blobdiff