Merge pull request #1 from dirkrombauts/master

Documentation for version 1.0

Author: dirkrombauts

.gitignore

@@ -1,2 +1,3 @@
 _site/
 .sass-cache/
+site/

Images/TeamCityHowTo/report_config.PNG

@@ -0,0 +1,11 @@
+# Arguments
+
+Pickles provides several arguments for you to customize how it operates.  Each arguments exact usage will depend on the runner that is being used (i.e. console, powershell, etc.).  The links below provide descriptions of each parameter and how it is used in the different runners along with information on defaults and ranges of possible values.
+
+* [Feature Directory](ArgumentsFeatureDirectory.md)
+* [Output Directory](ArgumentsOutputDirectory.md)
+* [Documentation Format](ArgumentsDocumentationFormat.md)
+* [System Under Test Name](ArgumentsSystemUnderTestName.md)
+* [System Under Test Version](ArgumentsSystemUnderTestVersion.md)
+* [Test Results Format](ArgumentsTestResultsFormat.md)
+* [Test Results File](ArgumentsTestResultsFile.md)

Images/TeamCityHowTo/required_files.png

@@ -0,0 +1,40 @@
+# Documentation Format
+
+## Explanation
+
+Allows the user to select what format the generated output will be written in.  Currently, the available options are:
+
+- HTML
+- Dhtml
+- Word (OpenXML)
+- JSON
+- Excel
+
+**Note**: The value passed to this argument is case-insensitive.  i.e. HTML = html= HtMl
+
+## Default Value
+
+html
+
+## Possible Values
+
+html, dhtml, excel, json, word
+
+## Usage
+
+### Console
+
+	Pickles.exe --documentation-format=Word
+
+	Pickles.exe -df=Word
+
+### Powershell
+
+	Pickle-Features -DocumentationFormat Word
+
+### MSBuild
+
+    <target Name="document">
+        <pickles DocumentationFormat="Word" />
+    </target>
+

Images/TeamCityHowTo/scenarios_teamcity.PNG

@@ -0,0 +1,32 @@
+# Feature Directory
+
+
+## Explanation
+
+Allows the user to tell Pickles the root directory where the feature files are located.  All files underneath this root directory will be added to the output documentation.
+
+## Default Value
+
+None as yet.
+
+## Possible Values
+
+Any valid directory path, either absolute or relative.
+
+## Usage
+
+### Console
+
+	Pickles.exe --feature-directory=C:\MyProject\Features
+
+	Pickles.exe -f=C:\MyProject\Features
+
+### Powershell
+
+	Pickle-Features -FeatureDirectory C:\MyProject\Features
+
+### MSBuild
+
+    <Target Name="document">
+        <Pickles FeatureDirectory="C:\MyProject\Features" />
+    </Target>

Images/TeamCityHowTo/test_reports.PNG

@@ -0,0 +1,32 @@
+# Output Directory
+
+## Explanation
+
+The folder where Pickles will put the generated output.
+
+## Default Value
+
+The current folder.
+
+## Possible Values
+
+Any valid directory path, either absolute or relative.
+
+## Usage
+
+### Console
+
+	Pickles.exe --output-directory=C:\GeneratedDocs
+
+	Pickles.exe -o=C:\GeneratedDocs
+
+### Powershell
+
+	Pickle-Features -OutputDirectory C:\GeneratedDocs
+
+### MSBuild
+
+    <Target Name="document">
+        <Pickles OutputDirectory="C:\GeneratedDocs" />
+    </Target>
+

docs/Arguments.md

@@ -0,0 +1,32 @@
+# System Under Test Name
+
+## Explanation
+
+This is the name of the system under test.  Since Pickles is designed to be used with any platform/language that supports Gherkin feature files we cannot rely on reading in an assembly or a jar file to retrieve metadata about the system under test.  Instead, The user can use this argument to name the system under test.
+
+## Default Value
+
+None.
+
+## Possible Values
+
+Any valid string.
+
+## Usage
+
+### Console
+
+	Pickles.exe --system-under-test-name=MyProject
+
+	Pickles.exe -sn=MyProject
+
+### Powershell
+
+	Pickle-Features -SystemUnderTestName MyProject
+
+### MSBuild
+
+    <Target Name="document">
+        <Pickles SystemUnderTestName="MyProject" />
+    </Target>
+