README generator


Keywords
readme generator, cli, generator, python, readme
License
Unlicense
Install
pip install readme-generator==2019.4.13

Documentation

Travis

Installation

$ [sudo] pip install readme-generator

Features

  • generate README from <section-name>.md sections
  • auto headers
  • readme_generator.Readme class

How it works

<global>/badges.md          global section
<global>/headers.json       global custom headers (optional). example: {"badges":""}
<global>/order.txt          global order. section names line by line

<repo>/section-name.md      section
<repo>/order.txt            custom order     (optional)

README.md:

<badges.md content>

#### Section-name
<section-name.md content>

Headers

custom header:

  • headers.json {"how":"How it works"}
  • #### Insert Custom header in the first line

without header: headers.json - {"badges":""} or empty first line/empty header

Examples

README/: README/features.md, README/examples.md, ...

$ python -m readme_generator README > README.md
readme_generator.Readme("README").save("README.md")

global config location

$README_GENERATOR_HOME, default is $XDG_CONFIG_HOME/readme-generator, e.g.:

~/.config/readme-generator

What's Next?

create readme_generator.Readme subclass(es)

class Readme_pypi(readme_generator.Readme):
    order = ["install", ..., "footer"]
    headers = {"footer":""}
    footer = "footer ..."

    def install(self):
        return "`$ [sudo] pip install %s`" % self.name

Related projects

readme-generator