commit
e7edf1a446
7 changed files with 106 additions and 0 deletions
@ -0,0 +1,4 @@
|
||||
# Used by "mix format" |
||||
[ |
||||
inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"] |
||||
] |
@ -0,0 +1,26 @@
|
||||
# The directory Mix will write compiled artifacts to. |
||||
/_build/ |
||||
|
||||
# If you run "mix test --cover", coverage assets end up here. |
||||
/cover/ |
||||
|
||||
# The directory Mix downloads your dependencies sources to. |
||||
/deps/ |
||||
|
||||
# Where third-party dependencies like ExDoc output generated docs. |
||||
/doc/ |
||||
|
||||
# Ignore .fetch files in case you like to edit your project deps locally. |
||||
/.fetch |
||||
|
||||
# If the VM crashes, it generates a dump, let's ignore it too. |
||||
erl_crash.dump |
||||
|
||||
# Also ignore archive artifacts (built via "mix archive.build"). |
||||
*.ez |
||||
|
||||
# Ignore package tarball (built via "mix hex.build"). |
||||
ann-*.tar |
||||
|
||||
# Temporary files, for example, from tests. |
||||
/tmp/ |
@ -0,0 +1,21 @@
|
||||
# Ann |
||||
|
||||
**TODO: Add description** |
||||
|
||||
## Installation |
||||
|
||||
If [available in Hex](https://hex.pm/docs/publish), the package can be installed |
||||
by adding `ann` to your list of dependencies in `mix.exs`: |
||||
|
||||
```elixir |
||||
def deps do |
||||
[ |
||||
{:ann, "~> 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/ann>. |
||||
|
@ -0,0 +1,18 @@
|
||||
defmodule Ann do |
||||
@moduledoc """ |
||||
Documentation for `Ann`. |
||||
""" |
||||
|
||||
@doc """ |
||||
Hello world. |
||||
|
||||
## Examples |
||||
|
||||
iex> Ann.hello() |
||||
:world |
||||
|
||||
""" |
||||
def hello do |
||||
:world |
||||
end |
||||
end |
@ -0,0 +1,28 @@
|
||||
defmodule Ann.MixProject do |
||||
use Mix.Project |
||||
|
||||
def project do |
||||
[ |
||||
app: :ann, |
||||
version: "0.1.0", |
||||
elixir: "~> 1.13", |
||||
start_permanent: Mix.env() == :prod, |
||||
deps: deps() |
||||
] |
||||
end |
||||
|
||||
# Run "mix help compile.app" to learn about applications. |
||||
def application do |
||||
[ |
||||
extra_applications: [:logger] |
||||
] |
||||
end |
||||
|
||||
# Run "mix help deps" to learn about dependencies. |
||||
defp deps do |
||||
[ |
||||
# {:dep_from_hexpm, "~> 0.3.0"}, |
||||
# {:dep_from_git, git: "https://github.com/elixir-lang/my_dep.git", tag: "0.1.0"} |
||||
] |
||||
end |
||||
end |
@ -0,0 +1,8 @@
|
||||
defmodule AnnTest do |
||||
use ExUnit.Case |
||||
doctest Ann |
||||
|
||||
test "greets the world" do |
||||
assert Ann.hello() == :world |
||||
end |
||||
end |
Loading…
Reference in new issue