better install uninstall instruction #152
Closed
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
This was referenced Sep 1, 2018
takluyver
reviewed
Sep 2, 2018
| @@ -3,18 +3,32 @@ | |||
| This is the main website for a pledge to stop supporting Python 2 for free in | |||
| open source software. | |||
|
|
|||
| # Preview the changes | |||
|
|
|||
| If you are lazy, just send a PR. The continuous integration will build a preview | |||
There was a problem hiding this comment.
I'd remove the 'lazy' and 'just', and start with "If you send a pull request, Netlify will automatically build a preview for you..."
Then I'd clarify under the run locally section that it's fine to use the preview, but if you do want to build the site locally, this is how.
|
|
||
| Modify the various files, refresh your browser and enjoy. | ||
|
|
||
| PRs welcomed. | ||
|
|
||
| # uninstall |
There was a problem hiding this comment.
Capitalise and make it a level 2 heading
| # Run locally | ||
|
|
||
| Install Jekyll : `gem install jekyll`, `gem install github-pages` | ||
| Install Jekyll, we recommend installing bundler first: `gem install bundler` |
There was a problem hiding this comment.
The first part of this doesn't quite read right. I'd drop the mention of Jekyll here.
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.
No description provided.