Documentation

[DraTeots]

I believe this project is awesome but it also needs an awesome documentation. Or at least better documentations... actually at least some examples.

Yes, there are tests but it is hard to read them.

[ColinH]

Thank you for the kind words - and the encouragement, we are aware that the documentation is one major point that still needs a lot of work.

We had originally planned on stabilising the code, and then writing the documentation ready for 1.0 release, however:

There are still a lot of ideas for things to add to the library so this might take a long time, while at the same time the core library is already very much usable.

For this reason we had already been considering doing some documentation first, and your asking for it helps with this decision and is a further motivation.

So please hang in there, something's coming as soon as possible, and while it might not be release-quality it should help a lot to get going...

[ColinH]

It's slowly getting better.

[ColinH]

While not finished, there is a lot more documentation now, and the basics should be somewhat covered. Feedback welcome!