From bb5817b783eee47fcb87704c86a91a510dffc476 Mon Sep 17 00:00:00 2001 From: Seth Tisue Date: Wed, 31 May 2017 11:15:03 +0200 Subject: [PATCH] add "quickstart" to top of readme I'm always looking for these instructions because I can't seem to remember them -- so put them right at the top for forgetful and/or impatient people --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 356ab5c4b1..de71a8ac11 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,16 @@ This repository contains the source for the Scala documentation website, as well as the source for "Scala Improvement Process" (SIP) documents. +## Quickstart ## + +To build and view the site locally: + + gem install bundler + bundle install + bundle exec jekyll serve -I + +For more details, read on. + ## Contributing ## Please have a look at [http://docs.scala-lang.org/contribute.html](http://docs.scala-lang.org/contribute.html) before making a contribution.