boilerplate-py/docs/index.md

# ${REPO_NAME}

**${REPO_DESCRIPTION}**

---

| [📑 Documentation][1] | [🧑‍💻 Source Code][2] | [🐛 Bug Tracker][3] |
|-----------------------|------------------------|---------------------|

---

## Usage

...

## Installation

`pip install ${REPO_NAME}`

## Dependencies

Python Version ..., OS ...


[1]: https://${REPO_OWNER_LOWER}.github.io/${REPO_NAME_LOWER}
[2]: https://github.com/${REPO_OWNER_LOWER}/${REPO_NAME_LOWER}
[3]: https://github.com/${REPO_OWNER_LOWER}/${REPO_NAME_LOWER}/issues
Major overhaul: - transition to `pyproject.toml` config - include license (Apache-2.0) - add dev tools - add documentation config (`mkdocs` based) - turn `README.md` into a symlink to docs `index.md` - add convenience scripts for testing and linting 2023-03-09 12:08:59 +01:00			`# ${REPO_NAME}`

Add relevant links to home/readme page 2023-06-24 20:33:30 +02:00			`${REPO_DESCRIPTION}`

			`---`

			`\| [📑 Documentation][1] \| [🧑‍💻 Source Code][2] \| [🐛 Bug Tracker][3] \|`
			`\|-----------------------\|------------------------\|---------------------\|`

			`---`
Major overhaul: - transition to `pyproject.toml` config - include license (Apache-2.0) - add dev tools - add documentation config (`mkdocs` based) - turn `README.md` into a symlink to docs `index.md` - add convenience scripts for testing and linting 2023-03-09 12:08:59 +01:00
			`## Usage`

			`...`

			`## Installation`

			`pip install ${REPO_NAME}`

			`## Dependencies`

			`Python Version ..., OS ...`
Add relevant links to home/readme page 2023-06-24 20:33:30 +02:00

			`[1]: https://${REPO_OWNER_LOWER}.github.io/${REPO_NAME_LOWER}`
			`[2]: https://github.com/${REPO_OWNER_LOWER}/${REPO_NAME_LOWER}`
			`[3]: https://github.com/${REPO_OWNER_LOWER}/${REPO_NAME_LOWER}/issues`