Skip to content

Commit

Permalink
renamed README to README.markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
Junya Ogura committed Aug 19, 2009
1 parent ba63a63 commit b644b86
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 33 deletions.
33 changes: 0 additions & 33 deletions README

This file was deleted.

49 changes: 49 additions & 0 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
Redmine Markdown Extra formatter
================================

This is a redmine plugin for supporting Markdown Extra as a wiki format.


What is redmine?
----------------

Redmine is a flexible project management web application.
See [the official site](http://www.redmine.org/) for more details.


What is Markdown Extra?
-----------------------

PHP Markdown Extra is a special version of PHP Markdown implementing some
features currently not available with the plain Markdown syntax.
(excerpt from http://michelf.com/projects/php-markdown/extra/)


Prerequisites
-------------

* Redmine >= 0.8.4
* BlueFeather gem - see http://ruby.morphball.net/bluefeather/index_en.html


Installation
------------

1. Copy the plugin directory into the vendor/plugins directory
2. Start Redmine
3. Installed plugins are listed on 'Admin -> Information' screen.


Credits
-------

* Junya Ogura (http://github.com/juno) for making the change to use BlueFeather library
* Yuki Sonoda (http://github.com/yugui) did the real work by creating the redmine_rd_formatter
* Jean-Philippe Lang for making the change to RedMine (based on Yuki's patch) to allow pluggable formatters


Suggestions, Bugs, Refactoring?
-------------------------------

Fork away and create a Github Issue. Pull requests are welcome.
http://github.com/juno/redmine_markdown_extra_formatter/tree/master

0 comments on commit b644b86

Please sign in to comment.