From 0dbba79bab77c8d4bf6a2e4984bdcee9d60e357b Mon Sep 17 00:00:00 2001 From: Alexander Meindl Date: Sun, 24 Apr 2016 11:07:26 +0200 Subject: [PATCH] Try use doc index for github --- README.md | 27 --------------------------- README.rst | 1 + docs/index.rst | 11 ++++++++--- 3 files changed, 9 insertions(+), 30 deletions(-) delete mode 100644 README.md create mode 120000 README.rst diff --git a/README.md b/README.md deleted file mode 100644 index d70f606f..00000000 --- a/README.md +++ /dev/null @@ -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! diff --git a/README.rst b/README.rst new file mode 120000 index 00000000..d46ade85 --- /dev/null +++ b/README.rst @@ -0,0 +1 @@ +docs/index.rst \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 092d2389..bfa91426 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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