Repository navigation
README: short intro, reference material moves to the book - #701
Merged
Merged
Conversation
Rewrite the README as a front page: what snug is, the main properties, why (not) pick it, quick install, one example, a pointer to the user guide, requirements as a list and the license. The usage details, architecture, threat model and requirements prose leave the README. docs/src takes them in a follow-up change.
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
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.
README rewritten as front page. 524 -> ~130 lines.
Kept:
~/.ssh, parent not granted, target rw, no network,-p @netegress. Output from real run.docs/src/README.md)snug doctorRemoved from README: usage details, verb/directory clash, architecture, "What dies when", defends / does not defend, verifying, drafts, documentation section, requirements prose (subuid, containers, getent, tun).
Follow-up PR moves that prose into
docs/src(usage.md,architecture.md,threat-model.md,requirements.md,sessions.md). Until then README linksdocs/src/requirements.mddead and book lacks the removed text. Intended.make gategreen on clean checkout of this branch (docexamples_test.goreads README, finds 0 profile examples, floor met byscripts/README.md).