readme update - #32
Merged
Merged
Conversation
Signed-off-by: Tommy Carpenter <9419125+tommyjcarpenter@users.noreply.github.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.
Bring the README back in line with the code, and remove stale
--systypereferences left over from when systype became auto-detected.The README had drifted from
bootstrap/schema.pyand the boot order in several places: the main config file is actuallybootstrap_config.json(notconfig.json),linksare grouped by OS rather than by "location", andcommands/file_associationshad gained fields that were never documented. Separately,--systypewas removed as a flag a while back (systype is now inferred fromsys.platformand/etc/os-release), but an error message and a module docstring still told users to pass it.Changes:
README.md: correct the config filename tobootstrap_config.jsonthroughout; regrouplinksby OS and document the per-link / per-dirsudooption; document thecommands/post_commands{cmd, check, label}object form and thatcommandsruns before packages; document the optionalname/icon/labelfields onfile_associations; remove the duplicate Prerequisites section and a couple of stale intro paragraphs; note that python 3.10+ is required.bootstrap/runboot.py: the auto-detect failure message no longer references the removed--systypeflag; it now lists the supported platforms instead.bootstrap/os_specific/windows.py: module docstring updated; systype is auto-detected as "windows" on win32, not set via a flag.