on 465cc1c help sign in
Idris-dev/docs/README.md
39 lines 1.2 kB history raw
1# Documentation for the Idris Language.
4This manual has been prepared using ReStructured Text and the [Sphinx Documentation Generator](http://sphinx-doc.org) for future inclusion on [Read The Docs](http://www.readthedocs.org).
6## Dependencies
8To build the manual the following dependencies must be met. We assume that you have standard build automation tools already install i.e. `make`.
10### Sphinx-Doc
12Python should be installed by default on most systems.
13Sphinx can be installed wither through your hosts package manager or using pip/easy_install.
15### LaTeX
17LaTeX can be install either using your systems package manager or direct from TeXLive.
20## Build Instructions
22```sh
23make html
24make latexpdf
25```
27## Contributing
29The documentation for Idris has been published under the Creative
30Commons CC0 License. As such to the extent possible under law, /The
31Idris Community/ has waived all copyright and related or neighboring
32rights to Documentation for Idris.
34More information concerning the CC0 can be found online at:
36 http://creativecommons.org/publicdomain/zero/1.0/
39When contributing material to the manual please bear in mind that the work will be licensed as above.