Repository navigation
SCY-1: README for early adopters - #3
Merged
Merged
Conversation
…k start checked on a fresh clone with real output, the terminal interface, configuration, a grouped documentation index, contributing, security and the MIT licence with its dependencies; the package map moves to docs/architecture.md
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.
What
A new
README.md: what the project is and is not (with the early-software warning first), a quick start that was run on a fresh clone with real output, the terminal interface, configuration, the path from a headline to a decision, a grouped documentation index, contributing, security, the MIT licence with a note on dependency licences, and a disclaimer.The package map that used to be in the README moves unchanged to
docs/architecture.md.Licence
LICENSE(MIT, Copyright 2026 Botond Biro) was already present and GitHub detects it as MIT. The README now has a badge and a licence section. The dependencies compiled into the two programs are MIT, BSD or Apache-2.0; an MPL-2.0 module appears in the module graph but is not compiled in.Notes
The README links to
SECURITY.md, which comes with PR #2.How to check
Follow the quick start on a clean clone; every command in it was run that way.