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.

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

GRPC install instructions and production warning #74

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Attribution
-----------

This library is a fork of https://github.com/aloiscochard/grpc-haskell that we
have extended and released under the same [`LICENSE`](./LICENSE)
have extended and released under the same [`LICENSE`](./LICENSE). Please use with caution in production.

Installation
------------
Expand Down Expand Up @@ -119,6 +119,27 @@ There are basically two methods to accomplish this:
sha256 "efad782944da13d362aab9b81f001b7b8b1458794751de818e9848c47acd4b32"
```

Installing GRPC on Unix
Copy link
Contributor

Choose a reason for hiding this comment

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

Instead of recommending that the user clone the repo and update the submodules, I think we should instead recommend downloading the release package from the project's release page: https://github.com/grpc/grpc/releases.

e.g.

1. Download the 1.2 release: `curl -O https://github.com/grpc/grpc/archive/v1.2.0.tar.gz`
...

Even better is if we can suggest installation via a specific distro's package manager but I don't know how many versions of grpc core are available for Debian, etc.

-----------------------
1. Clone the repo
```
git clone https://github.com/grpc/grpc
cd grpc
```
2. Checkout version 1.2
```
git checkout tags/v1.2.0
```
3. Install sub modules
```
git submodule update --init
```
3. Make and Install
```
make
sudo make install
```

Using the Library
-----------------

Expand Down