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

No documentation? #18

Closed
ryanford opened this issue Feb 1, 2018 · 9 comments
Closed

No documentation? #18

ryanford opened this issue Feb 1, 2018 · 9 comments

Comments

@ryanford
Copy link

ryanford commented Feb 1, 2018

Any plans to make docs for the API?

@anael-seghezzi
Copy link
Owner

Not yet, but it's a good point, so I'll mark it as an improvement.

@nukeop
Copy link

nukeop commented May 2, 2018

I think this is preventing many people from taking a further interest in this project, it's hard (although possible) to figure out what's going on in the examples just from the code.

@triptych
Copy link

triptych commented Sep 1, 2018

Creating something you expect others to use and develop on will require comprehensive documentation. Otherwise you have an audience of one

@anael-seghezzi
Copy link
Owner

I don't really expect anything actually, I have done my share of open-source pro bono. But, hey, you all got a point, so I took some time to write a bit of documentation in the README (Usage) https://github.com/anael-seghezzi/CToy and CToy.h (API) https://github.com/anael-seghezzi/CToy/blob/master/ressources/include/ctoy.h

@carlsmith
Copy link

Thank you. I found this repo a while back, but couldn't get into it till I saw this till today. I'm now up and running, learning C with K&R and CToy. Cheers.

@QuentinWidlocher
Copy link

I never used C before and thought CToy would be a nice way to experiment with it but the lack of documentation (mainly for MaratisTCL and how to simply display a picture) is preventing me from moving forward, I guess I cannot be the only one, since your tool is for learning purpose too ?

@anael-seghezzi
Copy link
Owner

It's quite straightforward but I have some idle time because of COVID so I'll write some tutorials in the wiki. Stay tuned.

@anael-seghezzi
Copy link
Owner

Here is a start: https://github.com/anael-seghezzi/CToy/wiki

@anael-seghezzi
Copy link
Owner

New, how to make a bomberman clone: https://github.com/anael-seghezzi/CToy/wiki/Making-a-little-Bomberman-clone

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

No branches or pull requests

6 participants