hyperledger-cacti / cacti

Hyperledger Cacti is a new approach to the blockchain interoperability problem
https://wiki.hyperledger.org/display/cactus
Apache License 2.0
344 stars 286 forks source link

docs(build): ensure foundry build dependency is documented #3583

Open petermetz opened 1 month ago

petermetz commented 1 month ago

Description

On the satp-dev branch you can't run yarn install successfully unless foundry is installed on the computer prior to it. This is an undocumented build dependency at the moment as far as I know so opened this issue to keep track.

# This file contains the result of Yarn building a package (@hyperledger/cactus-plugin-satp-hermes@workspace:packages/cactus-plugin-satp-hermes)
# Script name: preinstall

  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed

  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0
100   167  100   167    0     0    939      0 --:--:-- --:--:-- --:--:--   943

  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0
100  2189  100  2189    0     0   3976      0 --:--:-- --:--:-- --:--:-- 12952
Installing foundryup...

Detected your preferred shell is bash and added foundryup to PATH.
Run 'source /home/someone/.bashrc' or start a new terminal session to use foundryup.
Then, simply run 'foundryup' to install Foundry.
command not found: foundryup

Acceptance Criteria

  1. The documentation accurately reflects all build dependencies so that people can

cc: @RafaelAPB

RafaelAPB commented 1 month ago

@petermetz thank you for taking care of this issue