Skip to content
Snippets Groups Projects
Verified Commit 261df597 authored by Dmitriy Zaporozhets's avatar Dmitriy Zaporozhets
Browse files

Improve readme. Addd missing dev dependencies to Gemfile

parent ca0ef812
No related branches found
No related tags found
No related merge requests found
Loading
Loading
@@ -4,11 +4,13 @@ gemspec
 
gem 'rake', '~> 10.0.3'
 
group :development do
group :development, :test do
gem 'pry'
gem 'RedCloth', '~> 4.2.9'
gem 'mocha', '~> 0.13.2'
gem 'org-ruby', '~> 0.8.1'
gem 'shoulda', '~> 3.4.0'
gem 'wikicloth', '~> 0.8.0'
gem 'minitest-reporters'
gem 'nokogiri-diff', '~> 0.1.2'
end
gollum lib -- A wiki built on top of Git
gollum lib -- A wiki built on top of Git [![build status](https://ci.gitlab.org/projects/7/status.png?ref=master)](https://ci.gitlab.org/projects/7?ref=master)
========================================
 
[![Build Status](https://travis-ci.org/gollum/gollum-lib.png)](https://travis-ci.org/gollum/gollum-lib)
Loading
Loading
@@ -18,10 +18,8 @@ Gollum-lib follows the rules of [Semantic Versioning](http://semver.org/) and us
 
## SYSTEM REQUIREMENTS
 
- Python 2.5+ (2.7.3 recommended)
- Ruby 1.8.7+ (1.9.3 recommended)
- Unix like operating system (OS X, Ubuntu, Debian, and more)
- Will not work on Windows (because of [grit](https://github.com/github/grit))
 
## INSTALLATION
 
Loading
Loading
@@ -484,25 +482,6 @@ wiki.delete_page(page, commit)
 
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.
 
## CONTRIBUTE
If you'd like to hack on Gollum-lib, start by forking the repo on GitHub:
http://github.com/gollum/gollum-lib
To get all of the dependencies, install the gem first. The best way to get
your changes merged back into core is as follows:
1. Clone down your fork
1. Create a thoughtfully named topic branch to contain your change
1. Hack away
1. Add tests and make sure everything still passes by running `rake`
1. If you are adding new functionality, document it in the README
1. Do not change the version number, I will do that on my end
1. If necessary, rebase your commits into logical chunks, without errors
1. Push the branch up to GitHub
1. Send a pull request to the gollum/gollum-lib project.
## RELEASING
 
Gollum-lib uses [Semantic Versioning](http://semver.org/). Having `x.y.z` :
Loading
Loading
@@ -521,16 +500,6 @@ $ rake gemspec
$ rake release
```
 
## BUILDING THE GEM FROM MASTER
```bash
$ gem uninstall -aIx gollum-lib
$ git clone https://github.com/gollum/gollum-lib.git
$ cd gollum-lib
gollum-lib$ rake build
gollum-lib$ gem install --no-ri --no-rdoc pkg/gollum-lib*.gem
```
## RUN THE TESTS
 
```bash
Loading
Loading
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment