Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved installations instructions to include Protobuf installation #199

Closed
wants to merge 1 commit into from
Closed

Improved installations instructions to include Protobuf installation #199

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add protobuf to the Pre-Requisites section above?

### Installing Protobuf on Debian based Linux:
```
$ sudo apt install protobuf-compiler
$ protoc --version
```

### Installing protobuf on Mac:
```
$ brew install protobuf
$ protoc --version
```
For other operating systems , you can find installation insturctions here [install protobuf](https://grpc.io/docs/protoc-installation/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?




### Clone the repo:
```
git clone https://github.com/bitcoin-dev-project/sim-ln
cd sim-ln
```

Install the CLI:
### Install the CLI:
```
make install
```
Expand Down