Please ignore my last diff; this is an improved version.
This diff sets up a directory (ntdocs) where documention and test cases and be put.
I sugest that the tree for this dir should mirror the actual code base for ease of use.
Thanks.
Index: ntdocs/readme.txt =================================================================== --- ntdocs/readme.txt (revision 0) +++ ntdocs/readme.txt (revision 0) @@ -0,0 +1,6 @@ +This directory contains the documentation for Reactos (test cases and the like). Please do NOT put actual code here. +Just enough to implement it. Only human lanuage and puedo-code is allowed here. If you reversed engeneered, it please keep the policy and DO NOT implement it. + +The tree layout for the docs should mirror that of the actual code tree for ease of use. + +Thanks. \ No newline at end of file
On Sat, 28 Jan 2006 01:52:03 -0600 Jerry crashfourit@gmail.com wrote:
Please ignore my last diff; this is an improved version.
This diff sets up a directory (ntdocs) where documention and test cases and be put.
I sugest that the tree for this dir should mirror the actual code base for ease of use.
Thanks.
Do we have a common template and a general format for the docs that will go in ntdocs? Is it different for different types of documents that go in here?
I can think of a few types:
1) Justifications for original reactos code that was not dirty room reverse engineered.
2) Documentation of method that have been dirty-roomed before
3) Documentation of tests an analysis that justify architectural decisions.
Also, how do we feel about test programs? I've got a few more that I never committed because people complained about them.