Improved installations instructions to include Protobuf installation #199
Conversation
This file contains 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
carlaKC
reviewed
Sep 11, 2024
| @@ -30,13 +30,29 @@ See our [tracking issue](https://github.com/bitcoin-dev-project/sim-ln/issues/26 | |||
| for updates on implementation support (contributions welcome!). | |||
|
|
|||
| ## Getting Started | |||
| Clone the repo: | |||
| First of all make sure protobuf is installed on your machine. | |||
There was a problem hiding this comment.
Could you add protobuf to the Pre-Requisites section above?
| $ brew install protobuf | ||
| $ protoc --version | ||
| ``` | ||
| For other operating systems , you can find installation insturctions here [install protobuf](https://grpc.io/docs/protoc-installation/) |
There was a problem hiding this comment.
Our aim for the getting started section is for it to be a very minimal set of steps for people to get started.
Could we move this to docs/developer and then link the section in the pre-requisites section?
|
Closing due to inactivity, please re-open if you'd like to pick this back up! |
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.
Protobuf is an important dependency of the sim-ln project as it powers GRPC communication which the lighning nework uses for client communications .
During installation of Sim-ln , one is likely to run into error due to protobuf not being installed on their device . This PR spells out how to install protobuf. This PR is as result of this issues 198