Skip to content

Commit

Permalink
Build instructions in README
Browse files Browse the repository at this point in the history
  • Loading branch information
mtolly committed Nov 15, 2014
1 parent 5e72e58 commit 589fdee
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,29 @@ Future work:

* Possibly use `loopchannel` to further shorten the assembly code.

## Build

Windows/Mac/Linux executables are posted on the [releases] page. To build the
latest code yourself:

[releases]: https://github.com/mtolly/pokemid/releases

1. Install the [Haskell Platform], or (for advanced users)
[GHC] + [Alex] + [Happy] + [`cabal-install`][cabal].
GHC 7.6 and 7.8 are supported but others may work.

[Haskell Platform]: https://www.haskell.org/platform/
[GHC]: https://www.haskell.org/ghc/
[Alex]: https://www.haskell.org/alex/
[Happy]: https://www.haskell.org/happy/
[cabal]: https://www.haskell.org/haskellwiki/Cabal-Install

2. `cabal update` if necessary to download package lists.

2. In the `pokemid` directory, `cabal install` to build and install.
Or, `cabal build` and move `dist/build/pokemid/pokemid` to the
directory of your choice.

## Usage

pokemid in.asm out.mid # assembly to MIDI
Expand Down

0 comments on commit 589fdee

Please sign in to comment.