Clone

HTTPS: git clone https://vervis.peers.community/repos/yEzqv

SSH: git clone USERNAME@vervis.peers.community:yEzqv

Branches

master

22.mdwn

[[!template id=ticket class=proposal]]

[[!meta title=“Support custom README rendering”]]

Issue

Repo hosting web apps usually display at least 2 things in the main repo page:

File tree of repo contents in the “master” branch
Plain-text or Markdown rendering of the README file

This hardcoded convention becomes a problem sometimes, for example in Haskell. Haskell projects usually have a cabal file which defines both technical aspects (such as package dependencies, source files, language extensions) and human interface aspecs (such as project summary, description, author and maintainer details, bug reporting address, project website, source code repo link). Hackage, the Haskell package repository, uses the cabal file to display project information, and Cabal uses it to determine how to build and install the package on the user’s system.

Where do you put the project description then? In the cabal file? In the README? In both?

Here’s a proposal. Besides rendering the README, support several other main page rendering schemes, so that people never have to repeat details in the README if they already specify them somewhere else. I imagine Haskell isn’t the only case which has this issue. Examine other languages which have package repositories too. Ruby gens, Python eggs, Lua rocks and so on.

Plan

None yet.

Result