mirror of
https://github.com/unclechu/gRPC-haskell.git
synced 2024-11-05 02:39:42 +01:00
Add instructions on how to install and run compile-proto-file
(#91)
You can use `nix-env` to install any derivation that outputs binaries underneath a `bin/` directory, so we can reuse `nix-env` for installing binaries built by this project.
This commit is contained in:
parent
8732a669c0
commit
6888394dfa
1 changed files with 24 additions and 0 deletions
24
README.md
24
README.md
|
@ -1,3 +1,27 @@
|
|||
Installation
|
||||
------------
|
||||
|
||||
Run the following command from the root of this repository to install the
|
||||
`compile-proto-file` executable:
|
||||
|
||||
```bash
|
||||
$ nix-env -iA grpc-haskell -f release.nix
|
||||
```
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
```bash
|
||||
$ compile-proto-file --help
|
||||
Dumps a compiled .proto file to stdout
|
||||
|
||||
Usage: compile-proto-file --proto FILEPATH
|
||||
|
||||
Available options:
|
||||
-h,--help Show this help text
|
||||
--proto FILEPATH Path to input .proto file
|
||||
```
|
||||
|
||||
Building and testing
|
||||
--------------------
|
||||
|
||||
|
|
Loading…
Reference in a new issue