Skip to content

Commit 0d0508d

Browse files
committed
update README
1 parent e66ce7e commit 0d0508d

2 files changed

Lines changed: 6 additions & 2 deletions

File tree

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,11 @@ If a message field is not mandatory, then it's marked as OPTIONAL by "OPTIONAL"
7878
as the last comment in documentation for the given field.
7979
Optional fields have defaults as described in the [ProtoBuf] v3 doc.
8080

81+
### Python protobuf files
82+
83+
To use the compiled python protobuf files in a project, install the module in `protobuf/compiled/python`.
84+
For example: add this project as a submodule and add `file:fleet-protocol/protobuf/compiled/python` to `requirements.txt`. Then it can be imported as `fleet_protocol_protobuf_files`.
85+
8186
## Repo structure
8287

8388
This repository contains a basic C API and CMake project to easily

protobuf/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ TARGET_LINK_LIBRARIES(<target> PUBLIC protobuf::libprotobuf protobuf-cpp-interfa
2121
Compile to all languages: (compiling python requires an extra step!)
2222

2323
```
24-
find definition -name "*.proto" -exec protoc -I=./definition --cpp_out=./compiled/cpp --csharp_out=./compiled/cs
25-
--python_out=./compiled/python/fleet_protocol_protobuf_files --go_out=./compiled/go/ --go_opt=paths=source_relative {} +
24+
find definition -name "*.proto" -exec protoc -I=./definition --cpp_out=./compiled/cpp --csharp_out=./compiled/cs --python_out=./compiled/python/fleet_protocol_protobuf_files --go_out=./compiled/go/ --go_opt=paths=source_relative {} +
2625
```
2726

2827
To compile files to a specific language only, use the specific `*_out` options in command.

0 commit comments

Comments
 (0)