The open source living documentation generator
C# JavaScript Cucumber HTML CSS F# Other
#359 Compare This branch is 1496 commits ahead, 1 commit behind x97mdr:master.
Latest commit 0e4d0c7 Jun 29, 2016 @dirkrombauts dirkrombauts committed on GitHub Release 2.8.0 (#354)
* Release 2.6.3 (#347)

* Enhancement to support Unix path! (#344)

I'm not sure you already got a try or a feedback about it but actually pickles run relatively well under Linux with mono which is interesting when like me you can't get a windows machine.

However without this little change we can't get the folder structure display correctly.

Could you integrate this modification?

Thanks

* Version Bump

* Update change log

* Release 2.7.0 (#351)

* Enhancement to support Unix path! (#344)

I'm not sure you already got a try or a feedback about it but actually pickles run relatively well under Linux with mono which is interesting when like me you can't get a windows machine.

However without this little change we can't get the folder structure display correctly.

Could you integrate this modification?

Thanks

* Release 2.6.3 (#348)

* Version Bump

* Update change log

* Add --enableComments Flag to Command Line - Default to True (#346)

* Command-Line Flag --comments - Default to True - Incl Unit Test

* Changed Command Line Argument --comments to --enableComments

* Added Enable Comments Option to MSBuild - Powershell - WPF Runners

* Fixed Bug with enableComments Property Not Being Used in MainViewModel

* Add EnableComments to the targets file

* Adapt change log

* Version bump to 2.7.0

* Edit release notes

* Version Bump (2.8.0)
Failed to load latest commit information.
chocolatey Remove automapper (#333) Apr 30, 2016
packages/nuget Updating nuget.exe (#331) Apr 25, 2016
src/Pickles Release 2.8.0 (#354) Jun 29, 2016
test-harness Some Examples were not recognized (#343) May 11, 2016
.editorconfig Add .editorconfig Oct 8, 2014
.gitattributes Adding .gitattributes Apr 10, 2013
.gitignore Add test harness (#342) May 11, 2016
CHANGELOG.md Release 2.8.0 (#354) Jun 29, 2016
CONTRIBUTING.md Add test harness (#342) May 11, 2016
CreateTestresults.cmd Add test harness (#342) May 11, 2016
DeployArtifacts.cmd Add script to deploy all artefacts Mar 21, 2016
DeployOutput.cmd Update deploy output scripts Jan 15, 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.8.0 (#354) Jun 29, 2016
build.cmd Add build.cmd Mar 15, 2016
build.fsx WIP: Fix: XUnit failed, if multiple TestResults.xml were used (#336) May 9, 2016
chocolatey.fsx Remove automapper (#333) Apr 30, 2016
nuget.fsx Remove automapper (#333) Apr 30, 2016
pickles.png Release 2.6.0 (#324) Apr 12, 2016
test.bat Use dynamically retrieved fake Oct 16, 2015
test.fsx Fix build process (#341) May 11, 2016
testOutput.proj Test scripts run once without experimentals and once with Mar 4, 2016
testOutput.ps1 Test scripts run once without experimentals and once with Mar 4, 2016
testRunnerCmd.cmd Test scripts run once without experimentals and once with Mar 4, 2016
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