readme-section 2021.5.17

README.md sections generator

Installation

$ pip install readme-section

Pros

• auto headings
• native, minimalistic, fast - only markdown files and shell script

How it works

1. make README sections files
2. make a shell script to build the README.md file

Examples

README.md.sh

#!/usr/bin/env bash

[ -e setup.py ] && echo "badges ..." && cat <<EOF
### Installation
pip install name
EOF

readme-section ".readme/pros.md"
readme-section ".readme/how.md" "How it works"
readme-section ".readme/examples.md"
readme-section ".readme/links.md"               # optional. empty if file not exists

$ bash -l README.md.sh > README.md

badges ...

### Installation
pip install name

### Features
features.md content ...

### How it works
how.md content ...