Add frontend README template#9
Merged
Merged
Conversation
A standardised README structure for all Dasher-<Platform> repos, synthesised
from the best parts of the existing Apple/Windows/Android/GTK/Web READMEs.
The template:
- Uses the original Dasher description ('information-efficient text-entry
interface, driven by continuous pointing gestures') + a consumer line
- Standardises: badges, status blockquote, build steps, architecture diagram,
repo layout table, contributing + DCO, license
- Includes guidance on what NOT to include (no feature matrix inline — link
to dasher.at/status; no v5 'PDAs' boilerplate; no duplicated DasherCore docs)
- Not an RFC — it's a documentation convention in the org .github repo
CONTRIBUTING.md updated to link to the template.
Signed-off-by: will wade <willwade@gmail.com>
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.
Standardised README structure for all Dasher- repos, synthesised from the best parts of existing READMEs (Apple's intro, Windows' architecture diagram, GTK's dependency table, Android's status blockquote, dasher-web's badges).
Not an RFC — it's a documentation convention. Each frontend copies and adapts it.
CONTRIBUTING.md updated to link to it.