Try use doc index for github

This commit is contained in:
Alexander Meindl 2016-04-24 11:07:26 +02:00
parent 48c31b94dc
commit 0dbba79bab
3 changed files with 9 additions and 30 deletions

View File

@ -1,27 +0,0 @@
# Redmine tweaks plugin
[![Dependency Status](https://gemnasium.com/alexandermeindl/redmine_tweaks.svg)](https://gemnasium.com/alexandermeindl/redmine_tweaks) [![Build Status](https://drone.io/github.com/alexandermeindl/redmine_tweaks/status.png)](https://drone.io/github.com/alexandermeindl/redmine_tweaks/latest)
### Documentation
Documentation is available at https://redmine-tweaks.readthedocs.org.
## Requirements
* Redmine version >= 2.6.0
* Ruby >= 2.0.0
* Gem package: see PluginGemfile
## Installation
Check the requirements!
Download the sources and put them to your vendor/plugins folder.
$ cd {REDMINE_ROOT}
$ git clone git://github.com/alexandermeindl/redmine_tweaks.git plugins/redmine_tweaks
$ bundle install --without development test
Restart Redmine and have a fun!

1
README.rst Symbolic link
View File

@ -0,0 +1 @@
docs/index.rst

View File

@ -4,26 +4,31 @@
contain the root `toctree` directive.
.. _Redmine: https://www.redmine.org
.. _Ruby: https://www.ruby-lang.org
.. _Gem packages: https://rubygems.org/
Welcome to Redmine Tweaks Plugin
================================
Tweaks for wiki and content including new macros for `Redmine`_.
.. image:: https://gemnasium.com/alexandermeindl/redmine_tweaks.svg
:target: https://gemnasium.com/alexandermeindl/redmine_tweaks
.. image:: https://drone.io/github.com/alexandermeindl/redmine_tweaks/status.png
:target: https://drone.io/github.com/alexandermeindl/redmine_tweaks/latest
* Documentation: https://redmine-tweaks.readthedocs.org
* Redmine.org plugin page: https://www.redmine.org/plugins/redmine_tweaks
* Github: https://github.com/alexandermeindl/redmine_tweaks
Requirements
------------
* Redmine version >= 2.6.0
* Ruby >= 2.0.0
* Gem package: see PluginGemfile
* `Ruby`_ >= 2.0.0
* `Gem packages`_: see PluginGemfile
Installation