Repository navigation
docs: refine README and fix stale paths in the manual - #1
Merged
Merged
Conversation
The README gains installation, usage and dependency sections. The manual and test plan still described the pre-split layout (Configs/.local/lib/hyde paths, tests/run.sh, core installer lists, a broken test-plan link); they now match this repository.
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID: Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
4 tasks done
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.
Follow-up to the review note on HyDE-Project/HyDE#2129 that the README needs more refining.
README
deezflow, what gets deployed where, and the dependencies (python-gobject,gtk3, Python 3.11+).hyde-shell settings,--system-info,--help.main.Manual / test plan (leftovers from before the repo split)
sh Configs/.local/lib/hyde/settings.shis nowsh settings.sh.Scripts/dots/hyde.tomlsync-path advice now points atapplications/plus HyDE'sScripts/dots/settings.toml.tests/run.shonly exists in HyDE; standalone commands are listed first.hyde-settings-tests.mdlink now points totests.md.Docs only.
python3 tests/settings_test.pypasses locally (22 tests); the deploy command in the README was run against a scratchHOMEand installed all five files.