docs: Add Mix Install/Docs, Start/Stop ABCI Server guides #3
Conversation
…ke 4.2.1 Previous version of GNU Make 3.81 supported Ranch 1.3.2, but after upgrading to GNU Make 4.2.1 it did not support Ranch 1.3.2, so it was necessary to upgrade to the latest Ranch 1.4.0
ltfschoen
changed the title
ltfschoen
changed the title
ltfschoen
changed the title
|
Based on feedback from @KrzysiekJ in #4 I've modified this Pull Request https://github.com/KrzysiekJ/abci_server/pull/3/files and removed the proposed change to the abci_server's Makefile so it still uses Ranch 1.3.2. The Pull Request now only proposes to modify the Readme and includes a Troubleshooting section that may help other users who encounter the IEx error |
|
|
||
| * Create a Fake Module named Foo | ||
| ``` | ||
| iex(1)> defmodule Foo do |
There was a problem hiding this comment.
This module doesn’t implement the abci_app behaviour, so it won’t be able to handle ABCI requests.
| <<70, ..., 117, ...>>, {:bar, 0}} | ||
| ``` | ||
|
|
||
| * Show ABCI Server Information (using `module_info/1` which is the Erlang equivalent of Elixir's `__info__/1`), Start ABCI Server, Stop ABCI Server |
There was a problem hiding this comment.
This is a generic Erlang function. I don’t see much utility in putting information about this in README.
| ] | ||
| ``` | ||
|
|
||
| * Run the ABCI Server's `start_listener` and `stop_listener` functions |
There was a problem hiding this comment.
This is already written in doc/overview.edoc (though for Erlang).
| :ok | ||
| ``` | ||
|
|
||
| * Test the Running ABCI Server (Erlang) in separate Bash Terminal Tab - https://github.com/tendermint/abci#tools |
There was a problem hiding this comment.
This is Tendermint-related documentation, no need to duplicate it here.
|
|
||
| * Documentation Generation. Open Documentation in Web Browser | ||
| ```bash | ||
| cd deps/abci_server/ && make docs && open doc/index.html && cd ../../ |
There was a problem hiding this comment.
This is already covered in the “Documentation” section.
|
|
||
| * Install Mix Dependencies | ||
| ```bash | ||
| mix deps.get |
There was a problem hiding this comment.
This looks like a generic Elixir command, no need to put it here.
|
Left some comments. Generally I have a feeling that the docs provided are much redundant, not project-specific. If they get fixed (the current example will not work), they may become valuable as a blog post or tutorial or on wiki. For example, adding Erlang packages as dependencies to Elixir projects (and vice versa) is a generic topic and it should be covered perhaps in Elixir documentation. |
No description provided.