git.iko.soy/Idris-dev
on f572cd0 help sign in
Idris-dev/docs/README.md
35 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
29This manual is licenced under the following Creative Commons License.
31```
32This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/.
33```
35When contributing material to the manual please bear in mind that the work will be licensed as above. More information about contribution, such as style information is contained in CONTRIBUTING.md.