Difference between revisions of "Category talk:Howtos"

Revision as of 06:28, 17 January 2010

Please see What should be included in howtos. Jmandel 06:28, 17 January 2010 (UTC)

@@ Line 1: / Line 1: @@
 ==Suggested style for pages in this category==
-* Keep it simple. It's not the complete documentation, it's just a Howto.
+Please see [[What should be included in howtos]]. [[User:Jmandel|Jmandel]] 06:28, 17 January 2010 (UTC)
-* 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 [[Wikipedia:git (software)|git]] commit hash or [[Wikipedia:Subversion (software)|Subversion]] tag for source codes, the date and some checksum ([[Wikipedia:Sum (Unix)|sum]], [[Wikipedia:MD5|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!
-[[User:Jmandel|Jmandel]] 05:22, 17 January 2010 (UTC)