Skip to content

Commit

Permalink
More setup instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
gvwilson committed May 29, 2016
1 parent d87c1ea commit 32b70f1
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 9 deletions.
3 changes: 1 addition & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ and reviews of proposed changes are all welcome.
By contributing,
you agree that we may redistribute your work under [our license](LICENSE.md).
In exchange,
we will address your issues,
assess your change proposal,
we will address your issues and/or assess your change proposal as promptly as we can,
and help you become a member of our community.
Everyone involved in [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
agrees to abide by our [code of conduct](CONDUCT.md).
Expand Down
4 changes: 3 additions & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ This lesson shows how to use the
[Software Carpentry]({{ site.swc_site }}) and
[Data Carpentry]({{ site.dc_site }}) lesson template.
For guidelines on how to help improve our lessons and this template,
please see [the contribution guidelines][contributing].
please see [the contribution guidelines][contributing];
for guidelines on how to set up your machine to preview changes locally,
please see [the setup instructions](/setup/).

> ## Prerequisites
>
Expand Down
12 changes: 6 additions & 6 deletions setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,21 @@ permalink: /setup/

If you want to set up Jekyll
so that you can preview changes on your own machine before pushing them to GitHub,
you must do the following:
you must install the software described below.
(Note: Julian Thilo has written instructions for [installing Jekyll on Windows](http://jekyll-windows.juthilo.com/).)

1. Install Ruby.
1. **Ruby**.
This is included with Linux and Mac OS X;
the simplest option on Windows is to use [RubyInstaller](http://rubyinstaller.org/).
You can test your installation by running `ruby --version`.
For more information,
see [the Ruby installation guidelines](https://www.ruby-lang.org/en/downloads/).

2. Install [RubyGems](https://rubygems.org/pages/download)
2. **[RubyGems](https://rubygems.org/pages/download)**
(the package manager for Ruby).
You can test your installation by running `gem --version`.

3. Install [Jekyll](https://jekyllrb.com/) by running `gem install jekyll`.

Julian Thilo has written instructions for [installing Jekyll on Windows](http://jekyll-windows.juthilo.com/).
3. **[Jekyll](https://jekyllrb.com/)**.
You can install this by running `gem install jekyll`.

[template]: {{ site.workshop_repo }}

0 comments on commit 32b70f1

Please sign in to comment.