README.md sections generator
Project description
Installation
$ pip install readme-section
Pros
- auto headings
- native, minimalistic, fast - only markdown files and shell script
How it works
- make README sections files
- 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 ...
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.