search

anael-seghezzi / CToy

Interactive C live coding environment
Other
1.35k stars 70 forks source link

No documentation? #18

Closed ryanford closed 2 years ago

ryanford commented 6 years ago

Any plans to make docs for the API?

anael-seghezzi commented 6 years ago

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

nukeop commented 6 years ago

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 commented 6 years ago

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

anael-seghezzi commented 6 years ago

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 commented 6 years ago

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 commented 4 years ago

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 commented 4 years ago

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 commented 4 years ago

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

anael-seghezzi commented 4 years ago

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