Addressing the issue of clear build and install instructions for majo… - #3947
Open
HappiProgrammer wants to merge 1 commit into
Conversation
ardocrat
reviewed
Oct 3, 2026
| Then start a Grin node: | ||
|
|
||
| ```sh | ||
| grin server run |
Contributor
There was a problem hiding this comment.
this command is rather for servers, at desktop users launch it with grin.
| Then start a Grin node: | ||
|
|
||
| ```sh | ||
| grin server run |
Contributor
There was a problem hiding this comment.
same as for Linux, users at desktop type grin, they can run using target/release/grin
| ```sh | ||
| export PATH=`pwd`/target/release:$PATH | ||
| rustup target add x86_64-apple-darwin | ||
| cargo build --release --target x86_64-apple-darwin |
Contributor
There was a problem hiding this comment.
you dont need to specify target at actual platform to launch just with target/release/grin/
|
|
||
| ```sh | ||
| export PATH=`pwd`/target/release:$PATH | ||
| rustup target add x86_64-apple-darwin |
Contributor
There was a problem hiding this comment.
at x86 this target is installed by default
ardocrat
reviewed
Oct 3, 2026
| .\target\release\grin.exe server run | ||
| ``` | ||
|
|
||
| Or add `target\release` to your `PATH` and run `grin server run`. |
Contributor
There was a problem hiding this comment.
Need to mention command grin to have TUI interface at desktop
This file contains hidden or 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
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.
Implement GitHub issue #2559 in the Grin repository:
Clear Build and Install Instructions for each Major OS
Issue: #2559
First, inspect the repository and determine the current, correct build process. Pay particular attention to:
doc/build.mdREADME.mdCargo.tomlrust-toolchain/rust-toolchain.toml, if presentTask
Improve
doc/build.mdso a new contributor can build and run Grin from source without having to search through the repository.Organize the document into clear sections for the major operating systems that the repository actually supports, such as:
For each supported OS, document:
Use actual commands from the repository and make them copy-pasteable.
Also document:
Critical rules
doc/build.md.Before finishing
Review the final
doc/build.mdas if you were a first-time Grin contributor.Verify that:
Finally, show me:
Do not make unrelated changes.