Skip to content

Commit

Permalink
docs: Add Mix Installation and Documentation generation guide
Browse files Browse the repository at this point in the history
  • Loading branch information
ltfschoen committed Jan 26, 2018
1 parent ee7e167 commit 61a25bf
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,34 @@

An Erlang application that allows writing [Application Blockchain Interface](https://github.com/tendermint/abci) servers.

ABCI Server with Erlang bindings is used by the [Tendermint Ecosystem](http://tendermint.readthedocs.io/projects/tools/en/master/ecosystem.html#abci-servers)

This application uses [semantic versioning 2.0](http://semver.org/).

[erlang.mk](https://erlang.mk/) is used as a build tool.

## Installation with Mix

* Add ABCI Server (Erlang) to mix.exs. [Choose a Release Tag](https://github.com/KrzysiekJ/abci_server/tags)
```elixir
defp deps do
[
# ABCI Server (Erlang) - https://github.com/KrzysiekJ/abci_server
{:abci_server, git: "https://github.com/KrzysiekJ/abci_server.git", tag: "v0.4.0"}
]
end
```

* Install Mix Dependencies
```bash
mix deps.get
```

* Documentation Generation. Open Documentation in Web Browser
```bash
cd deps/abci_server/ && make docs && open doc/index.html && cd ../../
```

## Documentation

Run `make docs` and open `doc/index.html`.
Expand Down

0 comments on commit 61a25bf

Please sign in to comment.