Add basic documentation #21
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
venimus
reviewed
Jan 31, 2020
venimus
reviewed
Jan 31, 2020
edit references
dincho
reviewed
Jan 31, 2020
README.md
Outdated
|
|
||
| * [Libsodium](https://download.libsodium.org/doc/) | ||
| * [Openssl](https://www.openssl.org) | ||
| * gmp |
dincho
reviewed
Jan 31, 2020
README.md
Outdated
|
|
||
| # Run install tests | ||
|
|
||
| Downloading the [Git repository](https://github.com/aeternity/installer) itself and: |
There was a problem hiding this comment.
I don't think this is necessary as it implies the developer is already working with this repo source.
I mean, this line is for developers of the tool, not users.
venimus
reviewed
Jan 31, 2020
README.md
Outdated
| * [Openssl](https://www.openssl.org) | ||
| * gmp | ||
|
|
||
| See the documentation [here](https://github.com/aeternity/aeternity/blob/master/README.md) detailed instructions for manual installation. |
There was a problem hiding this comment.
This sentence seem is not grammatically correct.
There was a problem hiding this comment.
For manual installation see the [detailed instructions](https://github.com/aeternity/aeternity/blob/master/README.md).
venimus
reviewed
Jan 31, 2020
README.md
Outdated
|
|
||
| # Run install tests | ||
|
|
||
| Downloading the [Git repository](https://github.com/aeternity/installer) itself and: |
There was a problem hiding this comment.
Suggested change
| Downloading the [Git repository](https://github.com/aeternity/installer) itself and: | |
| Clone the [git repository](https://github.com/aeternity/installer) and run: |
venimus
reviewed
Jan 31, 2020
README.md
Outdated
| ##### Additional options | ||
|
|
||
| - `--no-prompt` - Disable confirmation prompt | ||
| - `--delete` - Deleting the directory where aeternity node will be installed |
There was a problem hiding this comment.
Suggested change
| - `--delete` - Deleting the directory where aeternity node will be installed | |
| - `--delete` - Clean the target directory before installation |
venimus
reviewed
Jan 31, 2020
README.md
Outdated
| @@ -5,16 +5,57 @@ Run below command to install latest version of aeternity node: | |||
| bash <(curl -s https://install.aeternity.io/install.sh) | |||
| ``` | |||
|
|
|||
| The latest argument is interpreted as version. | |||
There was a problem hiding this comment.
Suggested change
| The latest argument is interpreted as version. | |
| The last argument is interpreted as a version. |
dincho
previously approved these changes
Feb 3, 2020
venimus
approved these changes
Feb 19, 2020
dincho
approved these changes
Feb 26, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
close #20