[feature request] If a README exists, can we display it?

Bug #1967981 reported by Vern Hart
34
This bug affects 7 people
Affects Status Importance Assigned to Milestone
Launchpad itself
Triaged
Low
Unassigned

Bug Description

Most web-based software repos allow the display of a README on the project's summary page.

It seems a simple matter to check the root of the project's tree and if a README (or README.md) exists, render the file on the project's summary page. Markdown would be rendered but if the file is not markdown, displaying in a PRE block would be appropriate.

In the meantime, as a proof of concept, I wrote a super simple UserScript that matches http://git.launchpad.net/*/tree/* and scans the list of files for a README file and displays it at the bottom of the page. It uses a third party markdown converter to keep things simple.

http://vern.com/tmp/launchpad-readme.user.js

Tags: feature ui
Jürgen Gmach (jugmac00)
Changed in launchpad:
status: New → Triaged
importance: Undecided → Low
Colin Watson (cjwatson)
tags: added: ui
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.