Convert README to markdown and update it

This commit is contained in:
Victor LABORIE 2017-08-31 12:32:27 +02:00
parent 2082bb5de3
commit c00753ac1c
2 changed files with 61 additions and 41 deletions

61
README.md Normal file
View file

@ -0,0 +1,61 @@
# Redmine Wiki Notes Plugin
## Plugin installation
1. Copy the plugin directory into the vendor/plugins directory
2. Update your gems
3. Restart Redmine
## Usage
The following macros are added:
- note
- tip
- important
- warning
Which can be used in three ways:
~~~
{{note(Note with *wiki formatting*)}}
{{note
Alternately, you can put blocks of *wiki-formatted* text here.
}}
{{note(Or if you really want)
You can do both...
}}
{{tip
This is a tip
}}
{{warning
Be carefull with :
* razors
* knifes
* fire
}}
{{important
This is important message. Heed my words.
}}
~~~
![Screenshot](screenshot.png?raw=true "Screenshot")
## Credits
The icons and the stylesheet were taken from the DokuWiki Note-Plugin (© Olivier
Cortès and others, https://www.dokuwiki.org/plugin:note (GPLv2)).
For the contributors, please see the git commit log.
## License
This plugin is released under the GPLv2.

View file

@ -1,41 +0,0 @@
= Redmine Wiki Notes Plugin
== Plugin installation
1. Copy the plugin directory into the vendor/plugins directory
2. Restart Redmine
== Usage
The following macros are added:
* note
* tip
* important
* warning
which can be used in one of three ways:
{{note(text with *wiki formatting*)}}
{{note
Alternately, you can put blocks of *wiki-formatted* text here.
}}
{{note(Or if you really want)
You can do both...
}}
This displays a block in the wiki page with a corresponding
icon and the specified text.
== Credits
The icons and the stylesheet were taken from the DokuWiki Note-Plugin ((c) Olivier
Cortès and others, http://www.dokuwiki.org/plugin:note (GPLv2)).
For the contributors, please see the git commit log.
== License
This plugin is released under the GPLv2.