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

Document gollum executable in readme.

Browse Source
This commit is contained in:
Tom Preston-Werner
2010-07-29 17:29:23 -04:00
parent 762608f344
commit 7e94a80bd2
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+15
View File
@@ -35,6 +35,21 @@ to install the dependencies for the formats that you plan to use.
* [Textile](http://www.textism.com/tools/textile/) -- `gem install RedCloth` * [Textile](http://www.textism.com/tools/textile/) -- `gem install RedCloth`
## RUNNING
To view and edit your Gollum repository locally via the built in web
interface, simply install the Gollum gem, navigate to your repository via the
command line, and run the executable:
$ gollum
This will start up a web server running the Gollum frontend and you can view
and edit your wiki at http://localhost:4567. To get help on the command line
utility, you can run it like so:
$ gollum --help
## REPO STRUCTURE ## REPO STRUCTURE
A Gollum repository's contents are designed to be human editable. Page content A Gollum repository's contents are designed to be human editable. Page content