orgreadme-fy

OrgReadme-fy helps you create a README.org for your Emacs projects.

It can generate for you:

- A readme-template.org, so you don't have to start from scratch.

  This file will, upon creation, fetch some metadata from your package file
  (the main .el). It provides a skeleton of common sections.

- Summary tables and descriptive subtrees.

  These are automatically generated from your package file and from an
  optional examples.el file. They provide a list of functions, their
  signature, their docstring, and usage examples.

OrgReadme-fy is independent from, but goes hand-in-hand with,
Exemplify-ERT.

For all the details, please do see the README

Open it easily with:
  (find-file-read-only "README.org")   <--- C-x C-e here¹

or from any buffer:
  M-x orgreadme-fy-see-readme

or read it online:
  <https://flandrew.srht.site/listful/sw-emacs-orgreadme-fy.html>

¹ or the key that ‘eval-last-sexp’ is bound to, if not C-x C-e.