r10421: major development

[cl-photo.git] / doc / readme.lml

diff --git a/doc/readme.lml b/doc/readme.lml
new file mode 100755 (executable)
index 0000000..8465ab7
--- /dev/null
+++ b/doc/readme.lml
@@ -0,0 +1,66 @@
+;;; -*- Mode: Lisp -*-
+
+(in-package #:lml2)
+
+(html-file-page ("readme")
+  (html      
+   (:head
+    (:title "CL-PHOTO 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 "CL-Photo Documentation"))
+    ((:meta :name "author" :content "Kevin Rosenberg"))
+    ((:meta :name "keywords" :content "Common Lisp, Photography, Calculator")))
+
+   (:body
+    (:h1 "CL-Photo Documentation")
+    (:h2 "Overview")
+    (:p
+     ((:a :href "http://files.b9.com/cl-photo/") "CL-Photo")
+     " is a Common Lisp package for calculation functions used in photography. "
+     ((:a :href "http://files.b9.com/cl-photo") "CL-Photo") 
+     " is written and Copyright &copy; by "
+     ((:a :href "mailto:kevin@rosenberg.net") "Kevin Rosenberg")
+     ".")
+
+    (:p
+      "The home page for CL-Photo is "
+      ((:a :href "http://files.b9.com/cl-photo") "http://files.b9.com/cl-photo")
+      ".")
+     
+     (:h2 "Prerequisites")
+     (:ul 
+      (:li ((:a :href "http://cliki.net/asdf") "ASDF"))
+
+     (:h2 "References")
+     (:ul
+      (:li
+       ((:a :href "http://solo.colorado.edu/~walawend/TwilightLandscapes/DoF_article.shtml")
+        "http://solo.colorado.edu/~walawend/TwilightLandscapes/DoF_article.shtml")
+       ((:a :href "http://www.vanwalree.com/optics/dofderivation.html")
+        "http://www.vanwalree.com/optics/dofderivation.html")
+       ((:a :href "http://www.photo.net/learn/optics/lensFAQ")
+        "http://www.photo.net/learn/optics/lensFAQ")
+       ((:a :href "http://www.mhohner.de/formulas.php")
+        "http://www.mhohner.de/formulas.php")
+       )
+       ))
+       
+     (:h2 "Installation")
+     (:p
+      "The easiest way to install CL-Photo 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-photo")
+      " to automatically download and install the CL-Photo 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 CL-Photo.")
+     
+     (:h2 "Usage")
+     (:p
+      "Currently, there is no documentation on the functions provided by CL-Photo. However, the source code is instructive.")
+     )))
+