docs(build): add text build steps for Linux, Mac and Windows #2072
Conversation
#1963 Signed-off-by: Abhinav Srivastava <[email protected]>
AbhinavMir
requested review from
petermetz,
takeutak,
izuru0,
jagpreetsinghsasan and
sandeepnRES
as code owners
There was a problem hiding this comment.
- apt is only there on Debian and it's downstream distros so I would somehow make it clear and then in separate sections you could detail the steps for Win and Mac so that people don't get confused.
- Instead of npm, please use yarn where possible
- Do not install the
nodejspackage via apt (not even on the Debian distros). We strongly encourage/prefer the use of the node version manager tool (nvm) - Let's push people towards JDK 11 instead of JDK 8
Signed-off-by: Abhinav Srivastava <[email protected]>
Signed-off-by: Abhinav Srivastava <[email protected]>
|
have addressed 2,3,4 in latest commit. I think for 1, we can create a new issue to create separate build instructions on Windows and Mac. |
| ### Package structure - Main and Factory Plugin class | ||
| curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add - | ||
| echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list | ||
| sudo apt update && sudo apt install yarn |
There was a problem hiding this comment.
For yarn, we do have a npm script. One can run this npm script from the cactus root folder, npm run install-yarn
| @@ -1,91 +1,91 @@ | |||
| # Hyperledger Cactus Build Instructions | |||
| ### Cactus BUILD instruction | |||
There was a problem hiding this comment.
I believe saying Hyperledger Cactus (instead of just Cactus) here is better.
| sudo apt-get install docker-ce docker-ce-cli containerd.io docker-compose-plugin | ||
|
|
||
| ### Check that the package has been correctly installed | ||
| sudo docker run hello-world |
There was a problem hiding this comment.
After this line, reference can also be given to use docker without sudo, as mentioned here, https://docs.docker.com/engine/install/linux-postinstall/
| that can be helped by using the `npm run watch` script which can automatically | ||
| recompile packages as you modify them (and only the packages that you have | ||
| modified, not everything). | ||
| You can download and install VS Code from [here](https://code.visualstudio.com/download). It is suggested to install the git-graph and Docker plugins. |
There was a problem hiding this comment.
Here, we can also mention the npm-scripts plugin as well (https://marketplace.visualstudio.com/items?itemName=traBpUkciP.vscode-npm-scripts)
| The `npm run watch` script in action: | ||
| ``` | ||
| git clone https://github.com/hyperledger/cactus | ||
| yarn add |
There was a problem hiding this comment.
We can specify the npm run install-yarn prior toyarn add (yarn-add isn't required)
Issue: #1963
Signed-off-by: Abhinav Srivastava (abhinavmir#1898 on Discord)