Skip to content

Latest commit

 

History

History
50 lines (27 loc) · 1.39 KB

installation.md

File metadata and controls

50 lines (27 loc) · 1.39 KB
Raw

Installation

Set up this project to run locally. On Linux, macOS or Windows.

Requirements

  • Ruby - To install the project-scoped gems, including Jekyll.
  • Bundler - Used to manage Ruby gem dependencies in an isolated directory, to preserve your global gems.
  • Make - The docs here use the make command, which comes standard on macOS or Linux machine, but on Windows you need to download and install Make. Or, if you go to Makefile, you can look up the appropriate shell commands to run without make.

Clone

Optionally add this to your own repos - either fork this repo or click Use this Template.

Then clone your repo or this one.

Navigate to the repo root directory locally.

You can view the commands available in the Makefile or skip to the next step. Note that make only works in macOS or Linux. Thought, it is optional, as you can run commands directly

$ make help

Install system dependencies

Install Ruby and Bundler globally - follow this gist.

Install project dependencies

Install local gems.

$ make install

Upgrade

Run this command if needed upgrade to the latest gems.

$ make upgrade

When you upgrade, the Gemfile.lock file will be updated, if there are any changes. You can commit this to your own repo. This file is optional for GitHub Pages.