Category talk:Howtos
Revision as of 05:26, 17 January 2010 by Jmandel (talk | contribs) (→Suggested style for pages in this category)
Suggested style for pages in this category
- Keep it simple. It's not the complete documentation, it's just a Howto.
- Give minimal information needed to reproduce building the code and running it on a particular problem. It's OK to refer to specific README files in the source code for details.
- Include links to the code and data repositores, and to the documentation.
- Record versions with which it all worked, such as git commit hash or Subversion tag for source codes, the date and some checksum (sum, md5sum) for data files, and versions of the operating system, compilers, and libraries.
- Include some pictures and results.
- Update the page as the codes and data change, but do not delete the information on past working versions.
Thanks!
Jmandel 05:22, 17 January 2010 (UTC)