From fc1c7a713b03758f241c69fe3dbd6b9d153b082f Mon Sep 17 00:00:00 2001 From: Will Pennell Date: Sun, 20 Apr 2014 11:24:38 -0400 Subject: [PATCH] Update _template.md Adding more description to the tool template. These are some of the things I would be looking for when using a tool. --- tools/_template.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/tools/_template.md b/tools/_template.md index f268b51..4ea633b 100644 --- a/tools/_template.md +++ b/tools/_template.md @@ -1,17 +1,30 @@ -# Template Tool +# Tool Name Notes ------- +General information about the tool. + +What would you use this tool for? +Why would you use it? + Help Text ------- ``` Text output goes here + +For graphical tools, please include a note stating "This is a graphical tool" and include an example of how to launch the tool ``` Example Usage ------- +Any helpful examples found around the web or from personal experience + +``` +Actual commands can go here +``` Links ------- - +Include a link to the tools source / github / sourceforge / etc. +Include any links to helpful example such as videos, webpages, etc.