-
Notifications
You must be signed in to change notification settings - Fork 40
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Quick start quide #83
Conversation
README.md
Outdated
@@ -6,6 +6,44 @@ | |||
|
|||
The Erlang Performance Lab tool (erlangpl for short) can be started using escript or as a regular Erlang release. | |||
|
|||
### Quick start guide | |||
|
|||
#### 1. Download the prebuilt `erlangpl` script by click on [link](https://github.com/erlanglab/erlangpl/releases/download/0.8.1/erlangpl.tar.gz) or type in the command shell: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe something like:
Download the prebuilt
erlangpl
script from here or type in the command shell:
README.md
Outdated
(using `-name` or `-sname` flag). Click | ||
[here](http://erlang.org/doc/reference_manual/distributed.html#id88377) to learn more. | ||
* Both the node's and the erlangpl's cookies must match. You can set the node's | ||
cookie by run it with `-setcookie` flag. Keep in mind when you do not set a cookie |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe:
running it with
-setcookie
flag
README.md
Outdated
for the node it will be automatically set using `$HOME/.erlang.cookie`. See the | ||
[official Erlang documentation](http://erlang.org/doc/reference_manual/distributed.html#id88604) | ||
to learn more. | ||
* The `erlangpl` script must run on OTP 19.3 or higer. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
higer -> higher
``` | ||
|
||
#### 4. Visit http://localhost:37575 | ||
|
||
### Download prebuilt script |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would put some additional header to distinguish those section, because you have same paragraph in previous Paragraph.
Maybe giant header with link named Download
would be in place.
README.md
Outdated
``` | ||
wget https://github.com/erlanglab/erlangpl/releases/download/0.8.1/erlangpl.tar.gz | ||
``` | ||
#### 2. Untar downloaded archive using any GUI program or type in the command shell: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
shell command
README.md
Outdated
(using `-name` or `-sname` flag). Click | ||
[here](http://erlang.org/doc/reference_manual/distributed.html#id88377) to learn more. | ||
* Both the node's and the erlangpl's cookies must match. You can set the node's | ||
cookie by starting it with `-setcookie` flag. Keep in mind when you do not set a cookie |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Keep in mind that
You could also add a screencast (like 2 minutes) going through the main features. Also a make file with 3 targets to automatically set up a "test infrastructure" could be nice. I mean targtes like:
They would start a sample erlang/elixir node to monitor (possibly with some stuff already running so that something can be visualised), start the EPL node and make it connect to the test node and run the browser with the UI respectively. The |
I added the
Quick start guide
chapter to the README file. I think it could make it easier to start working with the EPL, especially for the Erlang/Elixir newcomers. Let me know what do you think :)