Will the documentation and manuals for this package be written?
Opened this issue · 3 comments
^^^
Hi Daniel,
I'm not sure to understand you.
If you're searching for the API documentation in HTML generated by ocamldoc, it's explained in the file INSTALL.txt:
The API documentation can be generated with:
$ make doc
see the file:
https://github.com/fccm/OCamlSDL2/blob/master/INSTALL.txt
And you can find examples in the directory examples
:
https://github.com/fccm/OCamlSDL2/tree/master/examples
If you're a beginner with ocaml and sdl2, I would recommend this repository:
https://github.com/fccm/ocaml-sdl2-minigames
(French and English are provided WIP, you can translate in your born language if you want)
I just put the API doc in HTML generated by ocamldoc in a gh-pages for you:
https://fccm.github.io/OCamlSDL2/
I hope it helps :)
Here is an initial draft for a manual for this package:
https://github.com/fccm2/OCamlSDL2/blob/master/MANUAL.md
Please tell me what you think about it.
(I want to appology, because indeed, a generated api-documentation is probably not enough, to find how to make some use of this)