Menu

#17 GUITAR.tool README-DEVELOPERS.txt file is poor

open
nobody
None
5
2010-03-18
2010-03-18
jlocke
No

Currently, there is a README-DEVELOPERS file in the top level directory of the GUITAR.tool folder. This file is very unhelpful, and it would be nice to let new developers know exactly how to develop for GUITAR without having to dig for documentation, like on the wiki.

The current text of the README simply displays that by checking out the folder, you will have "everything you need" to build, but doesn't tell you what to do. At the minimum, the README should just contain the SVN/ANT commands needed to get from ripping to replaying. A sample README might contain these commands:

ant modules
ant -Dproperties=jfcripper.properties -f jfcripper.xml
ant -Dproperties=GUIStructure2GraphConvert.properties -f GUIStructure2GraphConvert.xml
ant -Dproperties=TestCaseGenerator.properties -f TestCaseGenerator.xml
ant -Dproperties=jfcreplayer.properties -f jfcreplayer.xml

Simply putting these 5 commands in the README will get the user building and running all 4 (not including the Windows tools) GUITAR tools trivially. The README could be expanded to include instructions for the Windows tools.

Discussion


Log in to post a comment.

MongoDB Logo MongoDB