README mention of gollum-lib and whitespace fixes

This commit is contained in:
Sunny Ripert
2013-03-22 12:27:20 +01:00
parent b1021cf233
commit 4e04f5f540
+19 -10
View File
@@ -20,6 +20,7 @@ Gollum follows the rules of [Semantic Versioning](http://semver.org/) and uses
[TomDoc](http://tomdoc.org/) for inline documentation. [TomDoc](http://tomdoc.org/) for inline documentation.
## SYSTEM REQUIREMENTS ## SYSTEM REQUIREMENTS
- Python 2.5+ (2.7.3 recommended) - Python 2.5+ (2.7.3 recommended)
- Ruby 1.8.7+ (1.9.3 recommended) - Ruby 1.8.7+ (1.9.3 recommended)
- Unix like operating system (OS X, Ubuntu, Debian, and more) - Unix like operating system (OS X, Ubuntu, Debian, and more)
@@ -154,6 +155,7 @@ The first defined `h1` will override the default header on a page. There are two
`<!-- --- title: New Title -->` `<!-- --- title: New Title -->`
The first `h1` tag can be set to always override the page title, without needing to use the metadata syntax. Start gollum with the `--h1-title` flag. The first `h1` tag can be set to always override the page title, without needing to use the metadata syntax. Start gollum with the `--h1-title` flag.
## BRACKET TAGS ## BRACKET TAGS
A variety of Gollum tags use a double bracket syntax. For example: A variety of Gollum tags use a double bracket syntax. For example:
@@ -412,24 +414,25 @@ You can replace the string "blue-modern" with any supported style.
## API DOCUMENTATION ## API DOCUMENTATION
The Gollum API allows you to retrieve raw or formatted wiki content from a Git The [Gollum API](https://github.com/gollum/gollum-lib/) allows you to retrieve
repository, write new content to the repository, and collect various meta data raw or formatted wiki content from a Git repository, write new content to the
about the wiki as a whole. repository, and collect various meta data about the wiki as a whole.
Initialize the Gollum::Repo object: Initialize the `Gollum::Repo` object:
# Require rubygems if necessary # Require rubygems if necessary
require 'rubygems' require 'rubygems'
# Require the Gollum library # Require the Gollum library
require 'gollum' require 'gollum-lib'
# Create a new Gollum::Wiki object by initializing it with the path to the # Create a new Gollum::Wiki object by initializing it with the path to the
# Git repository. # Git repository.
wiki = Gollum::Wiki.new("my-gollum-repo.git") wiki = Gollum::Wiki.new("my-gollum-repo.git")
# => <Gollum::Wiki> # => <Gollum::Wiki>
By default, internal wiki links are all absolute from the root. To specify a different base path, you can specify the `:base_path` option: By default, internal wiki links are all absolute from the root. To specify a different
base path, you can specify the `:base_path` option:
wiki = Gollum::Wiki.new("my-gollum-repo.git", :base_path => "/wiki") wiki = Gollum::Wiki.new("my-gollum-repo.git", :base_path => "/wiki")
@@ -552,6 +555,7 @@ like Rack::Auth, OmniAuth, etc.
Your Rack middleware can pass author details to Gollum in a Hash in the session under the 'gollum.author' key. Your Rack middleware can pass author details to Gollum in a Hash in the session under the 'gollum.author' key.
## WINDOWS FILENAME VALIDATION ## WINDOWS FILENAME VALIDATION
Note that filenames on windows must not contain any of the following characters `\ / : * ? " < > |`. See [this support article](http://support.microsoft.com/kb/177506) for details. Note that filenames on windows must not contain any of the following characters `\ / : * ? " < > |`. See [this support article](http://support.microsoft.com/kb/177506) for details.
## CONFIG FILE ## CONFIG FILE
@@ -584,13 +588,18 @@ your changes merged back into core is as follows:
1. Send a pull request to the gollum/gollum project. 1. Send a pull request to the gollum/gollum project.
## RELEASING ## RELEASING
Gollum uses [Semantic Versioning](http://semver.org/).
x.y.z x.y.z
For z releases: For z releases:
$ rake bump $ rake bump
$ rake release $ rake release
For x.y releases: For x.y releases:
Update VERSION in lib/gollum.rb Update VERSION in lib/gollum.rb
$ rake gemspec $ rake gemspec
$ rake release $ rake release
@@ -604,8 +613,8 @@ your changes merged back into core is as follows:
## RUN THE TESTS ## RUN THE TESTS
bundle install $ bundle install
bundle exec rake test $ bundle exec rake test
## WORK WITH TEST REPOS ## WORK WITH TEST REPOS