Packages

Dummy library defining a calculator as a demo for how to create and distrute a package

Current section

Files

Jump to
dummy_calc README.md
Raw

README.md

# DummyCalc
`DummyCalc` is an Elixir library to demonstrate how to create a library,
how to use it from another module and how to publish it to Hex.
`DummyCalc` provides basic arithmetic operations:
* `DummyCalc.add(a,b)`: addition
* `DummyCalc.sub(a,b)`: subtraction
* `DummyCalc.mult(a,b)`: multiplication
* `DummyCalc.dic(a,b)`: division
## Installation
Depending on where the library is located, add `dummy_calc` to your list of
dependencies in `mix.exs`:
* From the local filesystem:
```elixir
def deps do
[
{:dummy_calc, path: "../dummy_calc" }
]
end
```
* From gitlab:
```elixir
def deps do
[
{:dummy_calc, git: "https://gitlab.com/mszmurlo/dummy_calc.git"}
]
end
```
* From Hex:
```elixir
def deps do
[
{:dummy_calc, "~> 0.1.0"}
]
end
```