README.md.tpl 658 B

1234567891011121314151617181920212223242526272829303132333435
  1. # {{PROJECT_NAME}}
  2. > {{ONE_LINE_DESCRIPTION}}
  3. {{BADGES}}<!-- e.g. build status, license, version -->
  4. ## Quick start
  5. ```bash
  6. {{INSTALL_CMD}}
  7. {{BUILD_CMD}}
  8. {{RUN_CMD}}
  9. ```
  10. ## What's inside
  11. {{ONE_PARAGRAPH_OVERVIEW}}
  12. ## Documentation
  13. {{DOC_INDEX}}<!-- bullet list of links to existing sub-docs -->
  14. - [Install](INSTALL.md){{IF_INSTALL}}
  15. - [Configure](CONFIGURE.md){{IF_CONFIGURE}}
  16. - [Usage](USAGE.md){{IF_USAGE}}
  17. - [Deploy](DEPLOY.md){{IF_DEPLOY}}
  18. - [Contributing](CONTRIBUTING.md){{IF_CONTRIBUTING}}
  19. - [Changelog](CHANGELOG.md){{IF_CHANGELOG}}
  20. ## Stack
  21. {{STACK_BULLETS}}<!-- one bullet per language/framework with version -->
  22. ## License
  23. {{LICENSE}}