Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Clone this wiki locally
Welcome to the Idris wiki!
Go ahead and start hacking! We're generally open to useful contributions.
If you'd like an easy place to get started, issues tagged low-hanging fruit in the issue tracker are those that we think will be fairly straightforward to implement, without requiring knowledge of the whole Idris system. Issues tagged patches welcome!, or FIXME/TODO are issues that are acknowledged, but are not priorities of the core developers at this time.
One of the best ways to get involved is writing documentation. That would be a highly valued contribution! The beginnings of a user manual exist, and contributing to this is a great way to learn the language and associated tools.
Documentation and support
The documentation, the official tutorial in particular, will hopefully get you quite far in using Idris, but it must be noted that there are still some important features on which the documentation is spotty. The mailing list and the Freenode channel are active and helpful, however, if you get stuck, and once you learn something that you did not find in the documentation, do consider contributing to the tutorial or to the language reference/manual!
- Official Idris tutorial
- Official Idris FAQ (maintained by Edwin Brady)
- Unofficial FAQ (maintained by anyone who wants to)
- Generated API docs
- You can post questions to the mailing list, and #idris on Freenode is generally fairly active.
- The still-incomplete unofficial manual aims at being the kind of documentation that you can look things up in.
- Idris for Haskellers
- There is a list of External Resources available, some made by us some by others. However, we cannot guarantee their accuracy or completeness.
To see proposals and development for new features please view this page.
A list of installation instructions for Platform
X can be found here.