Release on Hex.

This commit is contained in:
Pim Kunis 2020-10-12 23:00:24 +02:00
parent e677dd1808
commit 1ece5c1c79
3 changed files with 32 additions and 2 deletions

View file

@ -18,8 +18,17 @@ On OSX:
brew install fluidsynth
```
Clone this repo or put the [Hex dependency](https://hex.pm/packages/midi_player) in your mix.exs:
```elixir
{:midi_player, "~> 0.1.0"}
```
## Examples
MIDIPlayer takes "events" which for example represent to play a note for a time span.
It then converts these events to MIDI commands and schedules them.
First, let's create some events.
This plays a piano sound for the C note for 1 second:

View file

@ -1,6 +1,7 @@
defmodule MIDIPlayer.Event do
@moduledoc """
Several musical events which can be converted to MIDI commands.
All timings are in milliseconds.
"""

24
mix.exs
View file

@ -14,8 +14,13 @@ defmodule MIDIPlayer.MixProject do
source_url: "https://github.com/pizzapim/midi_player",
homepage_url: "https://github.com/pizzapim/midi_player",
docs: [
main: "MIDIPlayer"
]
extras: ["README.md"],
main: "readme"
],
# Hex stuff
description: description(),
package: package()
]
end
@ -25,6 +30,21 @@ defmodule MIDIPlayer.MixProject do
]
end
defp description do
"""
A MIDI player for Elixir.
MIDIPlayer takes musical "events" like playing a note, converts them to MIDI commands, schedules them and then lets you play them.
"""
end
defp package do
[
name: "midi_player",
licenses: ["GPL-3.0-or-later"],
links: %{"GitHub" => "https://github.com/pizzapim/midi_player"}
]
end
defp deps do
[
{:midi_synth, "~> 0.4.0"},