322693186c7fa4cc264b2f66671b878f37089fe9
[cl-photo.git] / doc / readme.lml
1 ;;; -*- Mode: Lisp -*-
2
3 (in-package #:lml2)
4
5 (html-file-page ("readme")
6   (html      
7    (:head
8     (:title "CL-PHOTO README")
9     ((:meta :http-equiv "Content-Type" :content "text/html; charset=iso-8859-1"))
10     ((:meta :name "Copyright" :content "Kevin Rosenberg 2002 <kevin@rosenberg.net>"))
11     ((:meta :name "description" :content "CL-Photo Documentation"))
12     ((:meta :name "author" :content "Kevin Rosenberg"))
13     ((:meta :name "keywords" :content "Common Lisp, Photography, Calculator")))
14
15    (:body
16     (:h1 "CL-Photo Documentation")
17     (:h2 "Overview")
18     (:p
19      ((:a :href "http://files.b9.com/cl-photo/") "CL-Photo")
20      " is a Common Lisp package for calculation functions used in photography. "
21      ((:a :href "http://files.b9.com/cl-photo") "CL-Photo") 
22      " is written and Copyright &copy; 2005 by "
23      ((:a :href "mailto:kevin@rosenberg.net") "Kevin Rosenberg")
24      ".")
25
26     (:p
27       "The home page for CL-Photo is "
28       ((:a :href "http://files.b9.com/cl-photo") "http://files.b9.com/cl-photo")
29       ".")
30      
31      (:h2 "Prerequisites")
32      (:ul 
33       (:li ((:a :href "http://cliki.net/asdf") "ASDF"))
34
35      (:h2 "References")
36      (:ul
37       (:li
38        ((:a :href "http://www.normankoren.com/Tutorials/MTF.html")
39         "http://www.normankoren.com/Tutorials/MTF.html"))
40       (:li
41        ((:a :href "http://www.vanwalree.com/optics/dofderivation.html")
42         "http://www.vanwalree.com/optics/dofderivation.html"))
43       (:li ((:a :href "http://www.photo.net/learn/optics/lensFAQ")
44         "http://www.photo.net/learn/optics/lensFAQ"))
45       (:li ((:a :href "http://www.mhohner.de/formulas.php")
46         "http://www.mhohner.de/formulas.php"))
47        ))
48        
49      (:h2 "Installation")
50      (:p
51       "The easiest way to install CL-Photo is to use the "
52       ((:a :href "http://www.debian.org/") "Debian")
53       " GNU/Linux operating system. You can then use the command "
54       (:tt "apt-get install cl-photo")
55       " to automatically download and install the CL-Photo package.")
56      (:p
57       "On a non-Debian system, you need to have "
58       ((:a :href "http://cclan.sourceforge.net/") "ASDF")
59       " installed to load the system definition file. You will need to change the source 
60        pathname in the system file to match the location where you have installed CL-Photo.")
61      
62      (:h2 "Usage")
63      (:p
64       "Currently, there is no documentation on the functions provided by CL-Photo. However, the source code is instructive.")
65      )))
66