Generate exercise READMEs from templates #694
Merged
Conversation
This file contains 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
added 2 commits
July 9, 2017 21:24
We are working towards making exercises stand-alone—that is to say: no more generating READMEs on the fly. This will give maintainers more control over each individual exercise README. The template uses the Go text/template package, and the default templates generate the exact same READMEs as we have been generating on the fly.
Smarticles101
approved these changes
Jul 10, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
We are working towards making exercises stand-alone.
That is to say: no more generating READMEs on the fly.
This will give maintainers more control over each individual exercise
README, and it will also make some of the backend logic for delivering
exercises simpler.
This does not mean, however, hand-crafting READMEs from scratch.
I wrote some tooling to make it possible to generate the READMEs from
a customizable template.
The template uses the Go text/template package, and the default template
will generate the same READMEs as we have been generating on the fly.
See the documentation in regenerating exercise readmes for
details.
The READMEs can be generated at any time using a new 'generate' command in configlet. This command has not yet landed in master or been released, but can be built from source in the generate-readmes branch on configlet.
Tracking progress of all tracks in: exercism/meta#15