Skip to content
setup.md 1.34 KiB
Newer Older
Greg Wilson's avatar
Greg Wilson committed
---
layout: page
title: Setup
permalink: /setup/
---
1. Installation instructions for core lessons are included in the [workshop template's home page][template],
   so that they are all in one place.
   The `setup.md` files of core lessons link to the appropriate sections of the [workshop template page][template].

2. Other lessons' `setup.md` include full installation instructions organized by OS
   (following the model of the workshop template home page).

Greg Wilson's avatar
Greg Wilson committed
--------

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

Greg Wilson's avatar
Greg Wilson committed
1.  **Ruby**.
Greg Wilson's avatar
Greg Wilson committed
    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/).

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

Greg Wilson's avatar
Greg Wilson committed
3.  **[Jekyll](https://jekyllrb.com/)**.
    You can install this by running `gem install jekyll`.
Greg Wilson's avatar
Greg Wilson committed

[template]: {{ site.workshop_repo }}