Skip to content

Commit b6674c2

Browse files
committed
Updated README
pointing to the new location of the pickles repository
1 parent 576648d commit b6674c2

File tree

1 file changed

+5
-23
lines changed

1 file changed

+5
-23
lines changed

README.md

+5-23
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,8 @@
1-
Introduction
2-
============
1+
Pickles has moved!
2+
==================
33

4-
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. Pickles can be incorporated into your build process to produce living documenation 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.
4+
Please watch this repository for changes and updates, as well as submitting Pull Requests.
55

6-
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.
6+
https://github.com/picklesdoc/pickles
77

8-
Pickles primarily produces static HTML files. The reason for this is that static HTML can be deployed to any old web server, you don't need any special libraries, databases or other tools that might limit your installation possiblities. If you are behind a corporate firewall with no internet access then you will appreciate this option! We plan to support other documentation formats in the future. Office Open XML (.docx), PDF and JSON formats are on the wishlist. If there are other formats you would like to see then why don't you post on the [newsgroup we have for pickles development][1]
9-
10-
Contributing
11-
------------
12-
13-
It's easy to contribute to Pickles, just setup an account on github and fork the project. When you have some code to contribute, send a pull request! There are plenty of ideas for contributions on the wiki and in the issues list.
14-
15-
Latest Builds
16-
-------------
17-
18-
You can find the latest development builds on the [CodeBetter.com TeamCity continuous integration server][2].
19-
20-
License
21-
-------
22-
23-
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
24-
25-
[1]: https://groups.google.com/forum/?hl=en-GB#!forum/pickles-dev "Pickles Google Group"
26-
[2]: http://teamcity.codebetter.com/project.html?projectId=project176&tab=projectOverview "Codebetter TeamCity Continuous Inegration Server"
8+
Thanks for all your support thus far.

0 commit comments

Comments
 (0)