Plugins Directory » Readme At Repositories
|
|
Author: | Tsubasa Nagasawa |
|---|---|---|
| Website: | https://github.com/simeji/readme_at_repositories | |
| Code repository: | https://github.com/simeji/readme_at_repositories | |
| Registered on: | 2013-06-11 (over 11 years ago) | |
| Current version: | 0.2.0 | |
| Compatible with: | Redmine 2.4.x, 2.3.x, 2.2.x, 2.1.x, 2.0.x, 1.4.x | |
| User ratings: |
Redmine plugin that displays contents of file named "README.*" at Repository tab
If you installed plugin for supporting Markdown, (for example'Redmine Redcarpet Markdown formatter') you cloud display README that is formatted.
Installation notes
Installation¶
Installation is very easy.
cd your_redmine_plugin_directory git clone git://github.com/simeji/readme_at_repositories.git
After that, please restart your redmine.
How to display READMEs¶
After installation, you can display README content, at the top of your project's "Repository" page
(any directory)
If you installed plugin for supporting Markdown, (for example
Redmine Redcarpet Markdown formatter ) you cloud display README that is formatted.
Your project Overview page. You click Repository tab.
You can show content of README.md (.txt, .rdoc, any extension ok. But only .md will be formatted.)
Changelog
0.2.0 (2013-06-12)
Compatible with Redmine 2.4.x, 2.3.x, 2.2.x, 2.1.x, 2.0.x, 1.4.x.