First commit

Initialise repository
This commit is contained in:
Ilja 2022-07-23 16:51:13 +02:00
commit cf49876a47
7 changed files with 106 additions and 0 deletions

4
.formatter.exs Normal file
View file

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

26
.gitignore vendored Normal file
View file

@ -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").
mfm_parser-*.tar
# Temporary files, for example, from tests.
/tmp/

21
README.md Normal file
View file

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

18
lib/mfm_parser.ex Normal file
View file

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

28
mix.exs Normal file
View file

@ -0,0 +1,28 @@
defmodule MfmParser.MixProject do
use Mix.Project
def project do
[
app: :mfm_parser,
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
test/mfm_parser_test.exs Normal file
View file

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

1
test/test_helper.exs Normal file
View file

@ -0,0 +1 @@
ExUnit.start()