Repository navigation
Rewrite README for users - #83
Merged
Merged
Conversation
…facing # Conflicts: # README.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
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.
Reorganises the README around what a user needs: install, quick start, a key table, what the launcher finds, running commands and terminal programs, settings by pane, and the command-line flags with pipe and skhd examples.
Also documents the Appearance settings (opacity, colors, font) that were missing, adds the license, and drops the informal "shit-ton of files" wording. The Development section is unchanged.
Note:
brew install dmenu-macis kept, but the cask is currently disabled by Homebrew for failing Gatekeeper, so it fails until releases are signed.