Next: User's Manual
Up: Introduction
Previous: Documentation writing softwares
  Contents
The documentation is structured as follow :
- The User's Manual, contains various explanations on how to use AriNET adequately. This includes an introduction to the GUI and a extensive description of the commands.
It also describes a chosen example, in order for the reader to get an idea of the concrete use of AriNET .
Eventually it provides a list of the error messages, enabling the user to debug his arithmetical networks.
- The Programmer's Manual, contains information about the source code and its structure.
It also contains a description of AriNET most important functions, such as my-veal, defconstraint or the environment model of evaluation.
This Programmer's Manual is provided in order to leave this project open for further extends.
- Critical Eye on AriNET: This section is summary of AriNET limitations, as well
as a melting pot of possible extends.
- Appendix A is a list of the books used to develop AriNET and its documentation.
- Appendix B contains the source code of the software.
- Appendix C lists the short-forms used in this manual.
- Appendix D is a copy of the paper ``Revised Report on the Algorithmic Language Scheme'' which can help the reader to use underlying Scheme commands.
- In this manual : GUI interactions are symbolized by a text in italic. For example if you have to click on Debug, then the word debug is going to be written like this : Debug
AriNET code to type is going to be represented like this:
(define (factorial n)
(if (= n 0)
1
(* n (factorial (- n 1)))))
Next: User's Manual
Up: Introduction
Previous: Documentation writing softwares
  Contents
dominique
2003-06-02