From 957c56c86e03a723d421065939ec90d56c8eb0b8 Mon Sep 17 00:00:00 2001 From: Oliver Steele Date: Thu, 20 Jul 2017 12:30:55 -0400 Subject: [PATCH] Link to releases page --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 75e6ea5..d914bd4 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,7 @@ [![][travis-svg]][travis-url] [![][coveralls-svg]][coveralls-url] [![][go-report-card-svg]][go-report-card-url] [![][license-svg]][license-url] -Gojekyll is a clone of the [Jekyll](https://jekyllrb.com) static site generator, written in the [Go](https://golang.org) programming language. It provides `build` and `serve` commands, with directory watch and live reload. - -Gojekyll is intended as an homage to Jekyll, and as a possible alternative in situations (such as iterative development of sites that don't use unsupported features) where speed is more important than total compatibility. +Gojekyll is a partially-compatible clone of the [Jekyll](https://jekyllrb.com) static site generator, written in the [Go](https://golang.org) programming language. It provides `build` and `serve` commands, with directory watch and live reload. |   | Gojekyll | Jekyll | Hugo | |-------------------------|-------------------------------------------|--------|--------------| @@ -23,6 +21,8 @@ Gojekyll is intended as an homage to Jekyll, and as a possible alternative in si - [Gojekyll](#gojekyll) - [Usage](#usage) - [Installation](#installation) + - [Binary Downloads](#binary-downloads) + - [From Source](#from-source) - [Status](#status) - [Current Limitations](#current-limitations) - [Other Differences](#other-differences) @@ -45,6 +45,13 @@ gojekyll help build ## Installation +### Binary Downloads + +1. Ubuntu (64-bit) and macOS binaries are available from the [releases page](https://github.com/osteele/gojekyll/releases). +2. [Optional] To use the `{% highlight %}` tag, you also need [Pygments](http://pygments.org): `pip install Pygments`. + +### From Source + Pre-requisites: 1. **Install go** (1) via [Homebrew](https://brew.sh): `brew install go`; or (2) [download](https://golang.org/doc/install#tarball).