Initial draft: basic build instructions on Readme #6498
Conversation
Inital draft for basic build instructions on the Readme page. Issue: #6348
|
Thank you @rjan90 for working on this!! |
README.md
Outdated
|
|
||
| #### Go | ||
|
|
||
| To build Lotus, you need a working installation of [Go 1.16.1 or higher](https://golang.org/dl/): |
There was a problem hiding this comment.
| To build Lotus, you need a working installation of [Go 1.16.1 or higher](https://golang.org/dl/): | |
| To build Lotus, you need a working installation of [Go 1.16.4 or higher](https://golang.org/dl/): |
| git clone https://github.com/filecoin-project/lotus.git | ||
| cd lotus/ | ||
| ``` | ||
|
|
There was a problem hiding this comment.
| > Note: The default branch `master` is the dev branch where the latest new features, bug fixes and improvement are in. However, if you want to run lotus on Filecoin mainnet and want to run a production-ready lotus, get the latest release[ here](https://github.com/filecoin-project/lotus/releases). |
README.md
Outdated
| 5. Build and install Lotus: | ||
|
|
||
| ```sh | ||
| make clean all |
There was a problem hiding this comment.
| make clean all | |
| make clean all #mainnet |
README.md
Outdated
|
|
||
| ```sh | ||
| export RUSTFLAGS="-C target-cpu=native -g" | ||
| export FFI_BUILD_FROM_SOURCE=1 |
There was a problem hiding this comment.
I'd say that the basic instructions should probably use the prebuilt proof binaries - this way you don't have to install rustup, and build the proofs library which takes a while. Then we can link to the instructions on docs.filecoin.io for people who may want a full from-source build
There was a problem hiding this comment.
I don’t think the proof prebuilds are compatible with different systems atm? And isn’t building from source a pretty standard thing to do now?
There was a problem hiding this comment.
oh checked with nemo, i was wrong, magik is right. @rjan90 mind making the update?
Make the basic build instructions use the prebuilt proof binaries instead of building them from source. Removed rustup as a dependency, and linked to it in the full docs instead.
Inital draft for basic build instructions on the Readme page. Issue: #6348