semvec/pypi-packages huggingface dataset:
readme-section 2021.5.17
README.md sections generator
License: Unlicense
Keywords: readme markdown

[![](https://img.shields.io/pypi/v/readme-section.svg?maxAge=3600)](https://pypi.org/project/readme-section/)
[![](https://img.shields.io/badge/License-Unlicense-blue.svg?longCache=True)](https://unlicense.org/)

### Installation
```bash
$ 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`
```bash
#!/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
$ bash -l README.md.sh > README.md
```
```markdown
badges ...

### Installation
pip install name

### Features
features.md content ...

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