Clarify readme install instructions #76
Merged
Conversation
This file contains 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
Installation instructions were missing from the README, and this seemed to be causing confusion for the users (who though they had to package `zpm` in order to install and use it).
Packaging is only interesting to maintainers and packagers, not end users. So I think it's a good idea to put a small warning/note at the top of the packaging section to keep users from falling down rabbit holes.
mgeisler
added a commit
that referenced
this pull request
Apr 3, 2014
…tions Clarify readme install instructions
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.
It is evident to me in #70 that our README is misleading and is encouraging users to try to package
zpmin order to just use the tool. This is bad.This change adds an
Installationsection with explicit install instructions and adds a warning to the packaging section (to prevent most users from falling down a rabbit hole).