Skip to content
master
Go to file
Code
This branch is 1640 commits ahead, 1 commit behind x97mdr:master.

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.

README.md

The End of the Road - For Me

It's been an amazing time for me to work on Pickles. Now it's finally time for me to lay down the mantle and move on. I am leaving Pickles completely.

Do you want to take over active development and maintenance at Pickles? Contact me directly at dirk dot rombauts at picklesdoc dot com. I will hand over everything Pickles-related to you. This email address will remain active until 11 December 2020.

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

You can’t perform that action at this time.