X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;f=doc%2Freadme.lml;h=5e153716722012c036055ab001ec6d947015a1fa;hb=dc3d60708af336b85c4766dc5a3aefd1a82b278d;hp=478d1d9a1a931c97d69406074df15667ecb403b6;hpb=d5d00b4cf4b4533884982c4fbc10189b19fb737e;p=lml.git diff --git a/doc/readme.lml b/doc/readme.lml index 478d1d9..5e15371 100644 --- a/doc/readme.lml +++ b/doc/readme.lml @@ -14,28 +14,23 @@ (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/") ".") + (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 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.") + (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.") + (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 @@ -49,11 +44,14 @@ (b (loop as x from 1 to 5 doing - (lml-print \" ~D\" (* x x))))")) + (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-print " ~D" (* x x)))))) - )))) + (lml-format " ~D" (* x x)))))) + )) + (hr) + (p [View this page's ,(a :href "http://lml.b9.com/" "LML") ,(a :href "readme.lml" "source").]) + ))