Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

better install uninstall instruction #152

Closed
wants to merge 2 commits into from
Closed

better install uninstall instruction #152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f7efb65
better install uninstall instruction
Carreau Sep 1, 2018
92dc712
add prev
Carreau Sep 1, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

on a netlify subdomain. Once the PR is submitted, look in the continuous integration
section for the `Netlify`, you may need to click 'Show all checks' section and click on `details`.

![](prev.png)

# Run locally

Install Jekyll : `gem install jekyll`, `gem install github-pages`
Install Jekyll, we recommend installing bundler first: `gem install bundler`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The first part of this doesn't quite read right. I'd drop the mention of Jekyll here.


Clone this locally, `cd` in the newly created directory.

Run `jekyll serve -w` in one terminal, open your browser to `localhost:4000`.
In the repository run `bundle install`

Run `bundle exec jekyll serve -w` in one terminal, open your browser to `localhost:4000`.

Modify the various files, refresh your browser and enjoy.

PRs welcomed.

# uninstall
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Capitalise and make it a level 2 heading


Run `bundle clean` form the root of the repository to remove packages.

# Add your project

If you just want to add your project to the list of participating projects, add
Expand Down
Binary file added prev.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.