From Gentoo Wiki
Jump to:navigation Jump to:search

readmuh is a small tool created to generate a 'landing page' file for overlays (ebuild repositories). It makes it a little more convenient for people to see what's cooking in your overlay at a single glance from the web.

It provides:

  • Markdown formatting (for CGit, GitLab, GitHub, etc.).
  • Descriptions of each ebuild.
  • Extended descriptions?
  • Available versions of each build.


Official EAPI proposal

Propose revision to the EAPI for an 'official' location for a repository's README file. Suggest the following files, in the following order:

  • repo_base/README
  • repo_base/
  • repo_base/README.rst

What happens if more than one file exists?