additionals/docs/index.rst
2016-04-24 07:37:45 +02:00

56 lines
1.4 KiB
ReStructuredText

.. redmine_tweaks documentation master file, created by
sphinx-quickstart on Sat Apr 23 16:31:21 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Redmine Tweaks Plugin
================================
.. 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
Requirements
============
* Redmine version >= 2.6.0
* Ruby >= 2.0.0
* Gem package: see PluginGemfile
Installation
============
Install redmine_tweaks
Check the requirements!
Download the sources and put them to your plugins folder.
.. code-block:: bash
$ cd $REDMINE_ROOT
$ git clone git://github.com/alexandermeindl/redmine_tweaks.git plugins/redmine_tweaks
$ bundle install --without development test
Contacts and Support
====================
I will be glad to get your feedback, `pull requests <https://github.com/alexandermeindl/redmine_tweaks/pulls>`_, `issues <https://github.com/alexandermeindl/redmine_tweaks/issues>`_, whatever. Feel free to contact me for any questions.
Table of contents
-----------------
.. toctree::
:maxdepth: 2
index
features
macros
changelog