Difference between revisions of "Help:Howtos"
Jump to navigation
Jump to search
(need step by step instructions) |
|||
| Line 2: | Line 2: | ||
* Keep it simple. It's not the complete documentation, it's just a Howto. | * Keep it simple. It's not the complete documentation, it's just a Howto. | ||
| − | * Give | + | * Give clear, specific step by step instructions to reproduce building the code and running it on a particular problem. |
| + | * It's OK to refer to particular README files and such in the source code as long as these give such step by step instructions. | ||
| + | * Do not refer to the documentation. The point of a Howto is to avoid reading the documentation! | ||
* Include links to the code and data repositores, and to the documentation. | * Include links to the code and data repositores, and to the documentation. | ||
| − | * | + | * Identify versions with which it all worked, such as [[git]] commit hash or [[Subversion]] tag for source codes, the date and some checksum (such as [[Wikipedia:cksum|cksum]], [[Wikipedia:md5sum|md5sum]]) for data files, and versions of the operating system, compilers, and libraries used. |
* Include some pictures and results. | * Include some pictures and results. | ||
* Update the page as the codes and data change, but do not delete the information on past working versions. | * Update the page as the codes and data change, but do not delete the information on past working versions. | ||
Revision as of 05:13, 18 January 2010
Suggested contents and style for pages in category Howtos
- Keep it simple. It's not the complete documentation, it's just a Howto.
- Give clear, specific step by step instructions to reproduce building the code and running it on a particular problem.
- It's OK to refer to particular README files and such in the source code as long as these give such step by step instructions.
- Do not refer to the documentation. The point of a Howto is to avoid reading the documentation!
- Include links to the code and data repositores, and to the documentation.
- Identify versions with which it all worked, such as git commit hash or Subversion tag for source codes, the date and some checksum (such as cksum, md5sum) for data files, and versions of the operating system, compilers, and libraries used.
- 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!