Browse Source

Initial commit

master
Shadowfacts 3 years ago
commit
81375ede91
Signed by: shadowfacts GPG Key ID: 94A5AB95422746E5
  1. 4
      .formatter.exs
  2. 24
      .gitignore
  3. 21
      README.md
  4. 30
      config/config.exs
  5. 18
      lib/mercury.ex
  6. 28
      mix.exs
  7. 8
      test/mercury_test.exs
  8. 1
      test/test_helper.exs

4
.formatter.exs

@ -0,0 +1,4 @@
# Used by "mix format"
[
inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
]

24
.gitignore

@ -0,0 +1,24 @@
# 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 3rd-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").
mercury-*.tar

21
README.md

@ -0,0 +1,21 @@
# Mercury
**TODO: Add description**
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `mercury` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:mercury, "~> 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/mercury](https://hexdocs.pm/mercury).

30
config/config.exs

@ -0,0 +1,30 @@
# This file is responsible for configuring your application
# and its dependencies with the aid of the Mix.Config module.
use Mix.Config
# This configuration is loaded before any dependency and is restricted
# to this project. If another project depends on this project, this
# file won't be loaded nor affect the parent project. For this reason,
# if you want to provide default values for your application for
# 3rd-party users, it should be done in your "mix.exs" file.
# You can configure your application as:
#
# config :mercury, key: :value
#
# and access this configuration in your application as:
#
# Application.get_env(:mercury, :key)
#
# You can also configure a 3rd-party app:
#
# config :logger, level: :info
#
# It is also possible to import configuration files, relative to this
# directory. For example, you can emulate configuration per environment
# by uncommenting the line below and defining dev.exs, test.exs and such.
# Configuration from the imported file will override the ones defined
# here (which is why it is important to import them last).
#
# import_config "#{Mix.env()}.exs"

18
lib/mercury.ex

@ -0,0 +1,18 @@
defmodule Mercury do
@moduledoc """
Documentation for Mercury.
"""
@doc """
Hello world.
## Examples
iex> Mercury.hello()
:world
"""
def hello do
:world
end
end

28
mix.exs

@ -0,0 +1,28 @@
defmodule Mercury.MixProject do
use Mix.Project
def project do
[
app: :mercury,
version: "0.1.0",
elixir: "~> 1.7",
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

8
test/mercury_test.exs

@ -0,0 +1,8 @@
defmodule MercuryTest do
use ExUnit.Case
doctest Mercury
test "greets the world" do
assert Mercury.hello() == :world
end
end

1
test/test_helper.exs

@ -0,0 +1 @@
ExUnit.start()
Loading…
Cancel
Save