wiki.ohea.xyz/gollum
10
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

Merge pull request #1084 from SkyCrawl/master

Browse Source 
Fixing the vague "running from source" description in README
This commit is contained in:
Dawa Ometto
2015-10-25 13:20:17 +01:00
parent ab42c0c0df 7362fd859b
commit bacd2893b9
1 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+9 -6
View File
@@ -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 <path-to-wiki>` 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).