docs: add requirements, updating, and uninstalling sections#22
Open
CheapFuck wants to merge 1 commit into
Open
docs: add requirements, updating, and uninstalling sections#22CheapFuck wants to merge 1 commit into
CheapFuck wants to merge 1 commit into
Conversation
The README covered install + usage but omitted prerequisites, update management, and removal. Round out the installation/usage guide: - Requirements: Linux host, bash, Podman (towel calls podman directly and the bundled distrobox config uses container_manager="podman"), curl, and the auto-installed Distrobox. - Updating towel: document the daily auto-check, manual --check/--apply, and how to disable it (--no-auto-check / TOWEL_NO_UPDATE_CHECK). - Uninstalling: towel remove plus the exact files the installer created, with a caveat about the shared distrobox/containers configs. Closes codam-coding-college#3
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.
Closes #3.
The README was populated in #8, so it's no longer empty — but as an installation/usage guide it was missing a few things. This rounds it out with three grounded sections (docs-only, no code changes):
bash, Podman,curl, and the auto-installed Distrobox. Podman is called out explicitly because towel uses it directly (podman container exists towelintowel-common) and the bundleduser/config/distrobox/distrobox.confsetscontainer_manager="podman"— yet the installer neither documents nor checks for it, so a host without Podman installs fine but fails attowel create.towel update --check/--apply, and how to turn the auto-check off/on (--no-auto-check/--auto-check, orTOWEL_NO_UPDATE_CHECK=1). All of this behaviour already exists but wasn't in the README.towel removeplus the exact files the installer creates, with a caveat thatdistrobox.conf/storage.confare shared Distrobox/Podman settings (the installer backs up any pre-existing versions with a.bak.*suffix).Everything documented is verified against the current code (installer,
towel-common,towel-update, the shipped configs). Shell-completion docs are intentionally left out here since they're owned by #20.