Current section

Files

Jump to
rebar3_lfe priv templates README.md.tpl
Raw

priv/templates/README.md.tpl

# {{name}}
[![Build Status][gh-actions-badge]][gh-actions]
[![LFE Versions][lfe badge]][lfe]
[![Erlang Versions][erlang badge]][version]
[![Tags][github tags badge]][github tags]
[![Project Logo][logo]][logo-large]
*{{description}}*
##### Table of Contents
* [About](#about-)
* [Build](#build-)
* [Start the Project REPL](#start-the-repl-)
* [Tests](#tests-)
* [Usage](#usage-)
* [License](#license-)
## About [↟](#table-of-contents)
TBD
## Build [↟](#table-of-contents)
```shell
$ rebar3 lfe compile
```
# Start the Project REPL [↟](#table-of-contents)
```shell
$ rebar3 lfe repl
```
# Tests [↟](#table-of-contents)
```shell
$ rebar3 as test lfe test
```
## Usage [↟](#table-of-contents)
TBD
## License [↟](#table-of-contents)
Apache License, Version 2.0
Copyright © {{copyright_year}}, {{author_name}} <{{author_email}}>.
<!-- Named page links below: /-->
[logo]: https://avatars1.githubusercontent.com/u/3434967?s=250
[logo-large]: https://avatars1.githubusercontent.com/u/3434967
[github]: https://github.com/ORG/{{name}}
[gitlab]: https://gitlab.com/ORG/{{name}}
-[gh-actions-badge]: https://github.com/ORG/{{name}}/workflows/Go/badge.svg
[gh-actions]: https://github.com/ORG/{{name}}/actions
[lfe]: https://github.com/lfe/lfe
[lfe badge]: https://img.shields.io/badge/lfe-2.0-blue.svg
[erlang badge]: https://img.shields.io/badge/erlang-19%20to%2024-blue.svg
[version]: https://github.com/ORG/{{name}}/blob/master/.github/workflows/cicd.yml
[github tags]: https://github.com/ORG/{{name}}/tags
[github tags badge]: https://img.shields.io/github/tag/ORG/{{name}}.svg
[github downloads]: https://img.shields.io/github/downloads/ORG/{{name}}/total.svg