elixir.README.md.mustache Maven / Gradle / Ivy
# {{moduleName}}
{{appDescription}}
### Building
To install the required dependencies and to build the elixir project, run:
```
mix local.hex --force
mix do deps.get, compile
```
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `{{#underscored}}{{packageName}}{{/underscored}}` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:{{#underscored}}{{packageName}}{{/underscored}}, "~> 0.1.0"}]
end
```
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/{{#underscored}}{{packageName}}{{/underscored}}](https://hexdocs.pm/{{#underscored}}{{packageName}}{{/underscored}}).
© 2015 - 2024 Weber Informatics LLC | Privacy Policy