grin
grin copied to clipboard
Clear Build and Install Instructions for each Major OS
The document: https://github.com/mimblewimble/grin/blob/master/doc/build.md
Needs Signifant Overview.
Installing on MacOS is as simple as:
- (Install Homebrew) follow instructions at: https://brew.sh/
- brew install rustup
- rustup-init
- git clone https://github.com/mimblewimble/grin.git
- cd grin
- cargo run --release
brew install rust
Not recommended. This should be "use rustup".
@antiochp thankyou for your correction; I have updated the issue with the receomended way.
Perhaps I should open a separate issue for this, but I noticed that the build requirements listed in the Dockerfile and the ones listed in the build guide differ. I went with the ones listed in the build guide when building and running Grin in a Docker container and it seems to work fine. Nonetheless, it is a little unclear. Are the build requirements in the Dockerfile outdated?
Would it be useful to have build environment setup instructions for macOS that are homebrew-free? On my first attempt to build grin s/w on my macOS I found that some things were broken due to prior use of homebrew for other projects. Not that I have anything against homebrew, but it does in a small way inject an additional dependency into the process. What do you think?
Actually by "use rustup" I meant (from https://rustup.rs)-
curl https://sh.rustup.rs -sSf | sh
Which is the recommended way to install rust on MacOS.
I think we should avoid using homebrew to install rustup (not saying don't use homebrew in general, its useful for installing many other things).
My comment above was low quality - I was asking if it would be good to have build instructions that do not use homebrew. My first experience attempting to build grin s/w was after using homebrew and my box was a bit of a rats nest of stuff. So, I repaved to get a clean start and figured out how to build it without using homebrew. I will dig up my notes and see if I can make something useful to post for macOS.
Build.md is definitely outdated and should be updated.
Hi, It seems no one is working on this issue. Can I start working on it?
@shubhsingh5901 of course, thanks for taking it on.