r5163: *** empty log message ***

[lml.git] / 2 / doc / readme.lml

diff --git a/2/doc/readme.lml b/2/doc/readme.lml
new file mode 100644 (file)
index 0000000..d64fcde
--- /dev/null
+++ b/2/doc/readme.lml
@@ -0,0 +1,73 @@
+;;; -*- Mode: Lisp -*-
+
+(in-package #:lml2)
+
+(page "readme"
+  (html      
+   (:head
+    (:title "LML README")
+    ((:meta :http-equiv "Content-Type" :content "text/html; charset=iso-8859-1"))
+    ((:meta :name "Copyright" :content "Kevin Rosenberg 2002 <kevin@rosenberg.net>"))
+    ((:meta :name "description" :content "Lisp Markup Language Documentation"))
+    ((:meta :name "author" :content "Kevin Rosenberg"))
+    ((:meta :name "keywords" :content "Common Lisp, HTML, Markup Langauge")))
+
+   (:body
+    (:h1 "LML Documentation")
+    (:h2 "Overview")
+    (:p
+     ((:a :href "http://lml.b9.com") "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://lml.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 "
+     ((:a :href "http://cclan.sourceforge.net/") "ASDF")
+     " 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 :border 1 :cellpadding 3)
+     (:tbody
+      (:tr
+       ((:td :colspan 2 :style "color:#000;background-color:#ccc;font-weight:bold;")
+       "Iteration"))
+      (:tr
+       (:td 
+       (:pre
+"(html
+   (:i \"The square of the first five integers are: )\"
+   (:b
+   (loop as x from 1 to 5 
+     doing
+     (lml-format \" ~D\" (* x x))))"))
+       (:td
+       (:i "The square of the first five integers are: ")
+       (:b
+        (loop as x from 1 to 5 
+              doing
+              (lml-format " ~D" (* x x))))))
+      ))
+    :hr
+    (:p
+     "View this page's "
+     ((:a :href "http://lml.b9.com/") "LML")
+     " "
+     ((:a :href "readme.lml") "source")
+     ".")
+    )))