From 7362fd859b0120ab8d0a499422ab3eb89f52688b Mon Sep 17 00:00:00 2001 From: SkyCrawl Date: Sun, 25 Oct 2015 13:12:36 +0100 Subject: [PATCH] Fixing the "running" section --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b0d81691..59f246a3 100644 --- a/README.md +++ b/README.md @@ -98,14 +98,17 @@ Simply: 2. Run: `gollum`. 3. Open `http://localhost:4567` in your browser. -If you wish to run from source, simply: - -1. Navigate to your git repository (wiki) via the command line. -2. Run: `bundle exec bin/gollum` -3. Open `http://localhost:4567` in your browser. - This will start up a web server (WEBrick) running Gollum with a web interface, where you can view and edit your wiki. +### Running from source + +1. `git clone https://github.com/gollum/gollum` +2. `cd gollum` +3. `[sudo] bundle install` (may not always be necessary). +4. `bundle exec bin/gollum` + * Like that, gollum assumes the target wiki (git repository) is the project repository itself. If it's not, execute `bundle exec bin/gollum ` instead. +5. Open `http://localhost:4567` in your browser. + ### Rack Gollum can also be ran with any [rack-compatible web server](https://github.com/rack/rack#supported-web-servers). More on that [over here](https://github.com/gollum/gollum/wiki/Gollum-via-Rack).