C# JavaScript Gherkin HTML CSS F# Other
Pull request Compare This branch is 1557 commits ahead, 1 commit behind x97mdr:master.
Latest commit 31533cb Feb 24, 2017 @dirkrombauts dirkrombauts committed on GitHub Release 2.14.0 (#437)
* Adapt change log

* Version Bump (2.14.0)

* Enable creation of outputs in deploy script

* Version 2.14.0
Permalink
Failed to load latest commit information.
chocolatey Adding Cucumber JSON Documentation Builder (#413) Jan 25, 2017
docs Release 2.14.0 (#437) Feb 24, 2017
packages/nuget Updating nuget.exe (#331) Apr 25, 2016
src/Pickles Release 2.14.0 (#437) Feb 24, 2017
test-harness Fix problem of NUnit 3.6 and truncation (#425) Feb 6, 2017
.editorconfig Add .editorconfig Oct 8, 2014
.gitattributes Adding .gitattributes Apr 10, 2013
.gitignore Feature/add ignore tag (#433) Feb 17, 2017
CHANGELOG.md Release 2.14.0 (#437) Feb 24, 2017
CNAME Create CNAME Aug 27, 2016
CONTRIBUTING.md Add test harness (#342) May 11, 2016
CreateTestresults.cmd Fix problem of NUnit 3.6 and truncation (#425) Feb 6, 2017
DeployArtifacts.cmd Release 2.14.0 (#437) Feb 24, 2017
DeployOutput.cmd Use docs directory to publish website (#363) Aug 18, 2016
DeployToChocolatey.cmd Use chocolatey from nuget instead of assuming it's installed Jan 4, 2016
DeployToNuget.cmd adapt deployment script to Nuget 3.x May 10, 2016
InstallPackages.cmd Use nuget packages instead of zip files for testing Jan 4, 2016
LICENSE Applied Apache 2.0 license to all source files Oct 30, 2011
README.md Add test harness (#342) May 11, 2016
build.bat Release 2.14.0 (#437) Feb 24, 2017
build.cmd Add build.cmd Mar 15, 2016
build.fsx Adding Cucumber JSON Documentation Builder (#413) Jan 25, 2017
chocolatey.fsx Adding Cucumber JSON Documentation Builder (#413) Jan 25, 2017
index.html Adding Cucumber JSON Documentation Builder (#413) Jan 25, 2017
nuget.fsx Adding Cucumber JSON Documentation Builder (#413) Jan 25, 2017
pickles.png Release 2.6.0 (#324) Apr 12, 2016
test.bat Use dynamically retrieved fake Oct 16, 2015
test.fsx Adding Cucumber JSON Documentation Builder (#413) Jan 25, 2017
testOutput.proj Adding Cucumber JSON Documentation Builder (#413) Jan 25, 2017
testOutput.ps1 Adding Cucumber JSON Documentation Builder (#413) Jan 25, 2017
testRunnerCmd.cmd Adding Cucumber JSON Documentation Builder (#413) Jan 25, 2017
testRunnerMsBuild.cmd Release 2.6.0 (#324) Apr 12, 2016
testRunnerPowerShell.cmd Batch file to test the powershell runner Dec 2, 2014

README.md

Pickles

Pickles is an open source living documentation generator that works on feature files written in the Gherkin language, popularized in tools like Cucumber and SpecFlow.

PRs Welcome Join the chat at https://gitter.im/picklesdoc/pickles Build status

Status
Docs Documentation Status
GitHub Release GitHub release
Chocolatey (pickles) Chocolatey
Chocolatey (picklesui) Chocolatey
NuGet (Pickles) NuGet
NuGet (Pickles.CommandLine) NuGet
NuGet (Pickles.MSBuild) NuGet

Pickles can be incorporated into your build process to produce living documentation in a format that is more accessible to your clients. Gherkin language files are written in plain text and stored in your source folder. This can make them inaccessible to clients who may not know how to work with source control or who are not interested in seeing all of the source code, just the features.

Why stop with just the features though? Pickles can also read plain text files written in the Markdown format so you can add other files to your feature to add all sorts of context. Well-written features are great to have but even the best written features can leave out some important context information. Markdown is very simple to write and is designed to be easily read even in plain text files so they are a great way of adding additional context to your feature files to turn them into a real set of living documentation.

Supported Output Formats

  • HTML
  • DHTML (javascript-enabled, search capabilities)
  • JSON
  • Word
  • Excel

If there are other formats you would like to see feel free to create a GitHub Issue.

Supported Test Runner Integrations

  • NUnit (versions 2.x and 3.x)
  • xUnit (versions 1.x and 2.x)
  • MSTest
  • Cucumber JSON
  • SpecFlow+ Runner (formerly known as SpecRun)

Contributing

Pickles welcomes contributions from the community! Please refer to Contributing.md for more information on how to contribute and how to set up your environment.

License

Pickles is licensed with the Apache License, version 2.0. You can find more information on the license here: http://www.apache.org/licenses/LICENSE-2.0.html