Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Will the documentation and manuals for this package be written? #15

Open
Nuxssss opened this issue Aug 12, 2020 · 3 comments
Open

Will the documentation and manuals for this package be written? #15

Nuxssss opened this issue Aug 12, 2020 · 3 comments

Comments

@Nuxssss
Copy link

Nuxssss commented Aug 12, 2020

^^^

@fccm
Copy link
Owner

fccm commented Aug 13, 2020

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)

@fccm
Copy link
Owner

fccm commented Aug 13, 2020

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 :)

@fccm2
Copy link

fccm2 commented Sep 7, 2024

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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants