Simplify readme #64
Merged
Simplify readme #64
Conversation
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
The chapter isn't very useful, most people know that git-forges like Github and Gitlab allow reporting issues, and the rest of the text doesn't add much value either. So replace it with a single sentence clarifying what the mode is for.
The mode requires somewhat involved initial setup with configuring indentation-hooks (not to mention even using Melpa requires first adding it to `package-archives'), so as it stands it doesn't really target people who doesn't even know what an init file is. That chapter of README isn't really useful IMO, let's just remove it.
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.
This removes "emacs rundown" chapter and replaces introductory chapter with just a sentence explaining what the mode is for. In short, the text being removed doesn't seem useful to anyone, see individual commits descriptions for more details.