36 lines
658 B
Smarty
36 lines
658 B
Smarty
# {{PROJECT_NAME}}
|
|
|
|
> {{ONE_LINE_DESCRIPTION}}
|
|
|
|
{{BADGES}}<!-- e.g. build status, license, version -->
|
|
|
|
## Quick start
|
|
|
|
```bash
|
|
{{INSTALL_CMD}}
|
|
{{BUILD_CMD}}
|
|
{{RUN_CMD}}
|
|
```
|
|
|
|
## What's inside
|
|
|
|
{{ONE_PARAGRAPH_OVERVIEW}}
|
|
|
|
## Documentation
|
|
|
|
{{DOC_INDEX}}<!-- bullet list of links to existing sub-docs -->
|
|
- [Install](INSTALL.md){{IF_INSTALL}}
|
|
- [Configure](CONFIGURE.md){{IF_CONFIGURE}}
|
|
- [Usage](USAGE.md){{IF_USAGE}}
|
|
- [Deploy](DEPLOY.md){{IF_DEPLOY}}
|
|
- [Contributing](CONTRIBUTING.md){{IF_CONTRIBUTING}}
|
|
- [Changelog](CHANGELOG.md){{IF_CHANGELOG}}
|
|
|
|
## Stack
|
|
|
|
{{STACK_BULLETS}}<!-- one bullet per language/framework with version -->
|
|
|
|
## License
|
|
|
|
{{LICENSE}}
|