Add documentation and licensing files - #3
Merged
Merged
Conversation
Prepares the project for an open source release: a README that explains what guerkchen is for (writing requirements in a fixed Gherkin format with a consistent vocabulary), install and build instructions, and a layout overview. Licensed under MIT, with the bundled gherkin-languages.json from cucumber/gherkin attributed separately. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01VaCnD9kSVwGRgFkUSPgn8Q
The README is the entry point for an open source release, so it should not require German. Same content and structure as before, with the example feature taken from Examples/demo-project/login.feature. The note about the German user interface stays, since that is what an English reader needs to know up front. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01VaCnD9kSVwGRgFkUSPgn8Q
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds comprehensive documentation and licensing files to establish the project's public presence and legal framework.
Changes
README.md: Complete project documentation in German covering:
LICENSE: MIT license establishing copyright (2026 René Fürstenberg) and usage terms
THIRD-PARTY-NOTICES.md: Attribution for included third-party assets:
gherkin-languages.jsonfile from the Cucumber projectNotable Details
https://claude.ai/code/session_01VaCnD9kSVwGRgFkUSPgn8Q