[[PageOutline(2-5,Contents,pullout)]]

= Repository Readme File Rendering

== Description

This plugin will render any file in listing starting with 'readme(*)' in some form, when browsing directories using the 'Browse Source' menu item (repository browser).

It uses the default Trac Mimeview rendering, and will render text (and source files) as usual (less line numbers). However, any supported output format can be used to provide HTML, like:
 * .rst files (restructured text)
 * wiki markup by setting file mime-type to `text/x-trac-wiki` (or making for instance .wiki file extension default by trac.ini setting `[mimeviewer] mime_map = ...., text/x-trac-wiki:wiki`)

Plugin supports any Trac > 0.11 (including 0.12 and 0.13dev, and including multi-repository).

== Bugs/Feature Requests

Existing bugs and feature requests for ReposReadMePlugin are 
[report:9?COMPONENT=ReposReadMePlugin here].

If you have any issues, create a 
[/newticket?component=ReposReadMePlugin new ticket].

[[TicketQuery(component=ReposReadMePlugin&group=type,format=progress)]]

== Download

Download the zipped source from [download:reposreadmeplugin here].

== Source

You can check out ReposReadMePlugin from [http://trac-hacks.org/svn/reposreadmeplugin here] using Subversion, or [source:reposreadmeplugin browse the source] with Trac.

== Installation

 1. Install or easy_install plugin as usual.
 1. Enable the plugin by adding the following to your `trac.ini` file: 
{{{#!ini
[components]
reposreadme.* = enabled
}}}

== Example

Examples - add your own directory if you use the plugin for a public site:
 * https://www.coderesort.com/p/open/browser/trac-talkplugin/trunk (license + wiki readme)
 * https://www.coderesort.com/p/reiseregningen/browser/trunk (license text file)
 * https://www.coderesort.com/p/epicode/browser/EPiCode.NetMeeting (rendering wiki markup)
 * https://www.coderesort.com/p/epicode/browser/BVNetwork.404Handler/6.x/404Handler (plain text readme file)

== Recent Changes

[[ChangeLog(reposreadmeplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:osimons] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''