Generate binaries #121
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,2 @@ | ||
| rosetta-cli | ||
| bin/ |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -29,10 +29,20 @@ Before diving into the CLI, we recommend taking a look at the Rosetta API Docs: | |
| * [Construction API](https://www.rosetta-api.org/docs/construction_api_introduction.html) | ||
|
|
||
| ## Install | ||
| To install `rosetta-cli` from source, run: | ||
| ``` | ||
| go get github.com/coinbase/rosetta-cli | ||
| ``` | ||
|
|
||
| To download a binary directly for MacOS and the latest release, run: | ||
| ``` | ||
| curl -L https://github.com/coinbase/rosetta-cli/releases/download/v0.4.1/rosetta-cli-0.4.1-darwin-10.6-amd64 -o rosetta-cli; chmod +x rosetta-cli; | ||
|
There was a problem hiding this comment. You may want to do a |
||
| ``` | ||
|
|
||
| Otherwise, binaries for other operating systems can be found [here](https://github.com/coinbase/rosetta-cli/releases). | ||
|
|
||
| _Downloading binaries from the Github UI will cause permission errors on Mac._ | ||
|
|
||
| ## Usage | ||
| ``` | ||
| CLI for the Rosetta API | ||
|
|
@@ -379,6 +389,7 @@ Global Flags: | |
| * `make test` to run tests | ||
| * `make lint` to lint the source code (included generated code) | ||
| * `make release` to run one last check before opening a PR | ||
| * `make compile version=RELEASE_TAG` to generate binaries | ||
|
There was a problem hiding this comment. Would you mind adding a small section to the README about using binaries and that a script is in progress? There was a problem hiding this comment. You may want to add that it is a known issue to click download on the release: There was a problem hiding this comment. Turns out curl bypasses this: There was a problem hiding this comment. You may want to include this in the README ^^ with a warning to not download on the UI |
||
|
|
||
| ### Helper/Handler | ||
| Many of the packages use a `Helper/Handler` interface pattern to acquire | ||
|
|
||
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
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
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.
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.
Is it possible to specify a tag here or do we need to checkout the code we want to compile @juliankoh ?
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.
This builds the code locally (as you can see from the . )
We can also build a specific tag but that would be a different command.