edward

 1# API Documentation
 2
 3This generates the API documentation for the edward library interface.
 4
 5## Dependencies
 6
 7In order to generate the documentation the following packages need to be installed:
 8
 9* [GNU make][gnu make]
10* [Discount][discount web]
11* [scmdoc][scmdoc github]
12
13## Usage
14
15After installing the aforementioned dependency, run the following command:
16
17    $ make -C doc
18
19This will generate several HTML files which provide an API documentation for R7RS libraries provided by edward.
20An index page which links to these files is also generated.
21Open `doc/index.html` in your favorite web browser to view this index page.
22
23[gnu make]: https://www.gnu.org/software/make
24[discount web]: http://www.pell.portland.or.us/~orc/Code/discount/
25[scmdoc github]: https://github.com/nmeum/scmdoc