Skip to content

Commit

Permalink
Initialize the project
Browse files Browse the repository at this point in the history
This is the base commit for the project. It was generated using 'mix
new' with Elixir 1.13.4 based on Erlang 24.3.3
  • Loading branch information
QMalcolm committed Aug 1, 2022
0 parents commit af31df0
Show file tree
Hide file tree
Showing 7 changed files with 106 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .formatter.exs
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Used by "mix format"
[
inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
]
26 changes: 26 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -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").
ex_rpg-*.tar

# Temporary files, for example, from tests.
/tmp/
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# ExRPG

**TODO: Add description**

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `ex_rpg` to your list of dependencies in `mix.exs`:

```elixir
def deps do
[
{:ex_rpg, "~> 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/ex_rpg>.

18 changes: 18 additions & 0 deletions lib/ex_rpg.ex
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
defmodule ExRPG do
@moduledoc """
Documentation for `ExRPG`.
"""

@doc """
Hello world.
## Examples
iex> ExRPG.hello()
:world
"""
def hello do
:world
end
end
28 changes: 28 additions & 0 deletions mix.exs
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
defmodule ExRPG.MixProject do
use Mix.Project

def project do
[
app: :ex_rpg,
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
8 changes: 8 additions & 0 deletions test/ex_rpg_test.exs
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
defmodule ExRPGTest do
use ExUnit.Case
doctest ExRPG

test "greets the world" do
assert ExRPG.hello() == :world
end
end
1 change: 1 addition & 0 deletions test/test_helper.exs
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ExUnit.start()

0 comments on commit af31df0

Please sign in to comment.