File: README.md

package info (click to toggle)
rust-prost-build 0.12.6-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 392 kB
  • sloc: makefile: 2
file content (27 lines) | stat: -rw-r--r-- 1,027 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
[![Documentation](https://docs.rs/prost-build/badge.svg)](https://docs.rs/prost-build/)
[![Crate](https://img.shields.io/crates/v/prost-build.svg)](https://crates.io/crates/prost-build)

# `prost-build`

`prost-build` makes it easy to generate Rust code from `.proto` files as part of
a Cargo build. See the crate [documentation](https://docs.rs/prost-build/) for examples
of how to integrate `prost-build` into a Cargo project.

## `protoc`

`prost-build` uses `protoc` to parse the proto files. There are two ways to make `protoc`
available for `prost-build`:

* Include `protoc` in your `PATH`. This can be done by following the [`protoc` install instructions].
* Pass the `PROTOC=<my/path/to/protoc>` environment variable with the path to
  `protoc`.

[`protoc` install instructions]: https://github.com/protocolbuffers/protobuf#protocol-compiler-installation

## License

`prost-build` is distributed under the terms of the Apache License (Version 2.0).

See [LICENSE](../LICENSE) for details.

Copyright 2017 Dan Burkert