aquaman
commented
13 years ago Done so far:
- INSTALL.txt (in the Source, and added as a wiki page)
- License doc (using Ruby GPL)
(Turns out the Readme is hard to do first, so I will write it last.)
Still To Do:
- History & Readme
- wondering if I should add an "API reference doc" to the repo, or just include the instructions for how to do it.
- I don't think I want to add to the size of the repo with potentially useless info to the majority of users.
- maybe I should host the latest API reference somewhere instead and include a link to it in the readme and other docs?
Story: as a user of this framework, I expect to see some docs to help me install, configure and use it, as well as a list of what's new or changed from previous versions so that I know how to use it correctly.
Currently: files missing include: Readme, Install, History, and some sort of License doc for the companies that require it before they permit their employees to use open software.
Expect: to see this info appear either in the Wiki or included with the Repo when you Download it.