| Author | Comment |
Zachary940
Wraith
Posted: 5 Apr 2006
18:54 GMT
Total Posts: 714 | what do i need to do to get my documentation not lacking?
so i can upload files
---
It is much easier to suggest solutions when you know nothing about the problem. |
TI Freak
Probe
Posted: 5 Apr 2006
19:37 GMT
Total Posts:
Edit | Go to the documentation folder for this file:
http://calcgames.org/cgi-bin/files/files.cgi?ID=1051
That should give you some general idea... |
Lunchbox
Carrier
Posted: 6 Apr 2006
15:00 GMT
Total Posts: 2007 | Plug... :D |
TI Freak
Probe
Posted: 6 Apr 2006
19:37 GMT
Total Posts:
Edit | Best example of decent-good documentation that I could think of... :P |
zkostik
Carrier
Posted: 6 Apr 2006
19:46 GMT
Total Posts: 2486 | Yeah, that's about what a good documentation should contain.
In general, you'd need to tell your users how to load it on their calc, what controls are being used, any possible bugs that result in a fatal crash or lockup (if applicable). You would probably want to write up a short description of your game (or file) and state its purpose and usage, like how to play for example. It's also a good idea to leave your contact email so people can report errors or give your their comments. Also, if you used somebody's code or help with your game, you should provide full credit (mention these people in author's page on file upload). We take proper credit giving very seriosly, so please make sure you do give everyone who worked on the file into account, in both authors and readme, but at least readme should give credit.
That's really about it. I hope this provides you with some insight on what a good readme would encorporate.
---
09 F9 11 02 9D 74 E3 5B D8 41 56 C5 63 56 88 C0 |
