meshtastic-protobuf/README.md

# Meshtastic-protobufs
[![Open in Visual Studio Code](https://open.vscode.dev/badges/open-in-vscode.svg)](https://open.vscode.dev/meshtastic/Meshtastic-protobufs)
[![CI](https://github.com/meshtastic/Meshtastic-protobufs/actions/workflows/ci.yml/badge.svg)](https://github.com/meshtastic/Meshtastic-protobufs/actions/workflows/ci.yml)

The protobuf definitions for the Meshtastic project (used by apps and the device code)

For questions on using these protobufs please post in our [forum](meshtastic.discourse.group). We are friendly and we love people building/extending this work.

For documentation please visit:
* [Meshtastic Docs](https://meshtastic.org/docs/developers/protobufs/api).

For more information on protobufs (and tools to use them with the language of your choice) see
* https://developers.google.com/protocol-buffers/docs/proto3

We are not placing any of these defs inside a package, because if you do the
resulting nanopb version is super verbose package mesh.

Protobuf build instructions:
* To build java classes for reading writing:
* protoc -I=. --java_out /tmp mesh.proto

To generate Nanopb c code:
* /home/kevinh/packages/nanopb-0.4.4-linux-x86/generator-bin/protoc --nanopb_out=/tmp -I=app/src/main/proto mesh.proto

Nanopb binaries available here:
* https://jpa.kapsi.fi/nanopb/download/ use nanopb 0.4.4

To lint:
* Install protolint: brew tap yoheimuta/protolint; brew install protolint
* Run it from the main directory: *protolint* lint .
* (optional) Have it fix the mundane warnings: *protolint* lint -fix .
* See https://github.com/yoheimuta/protolint for more info
Initial commit 2020-03-02 17:44:55 +00:00			`# Meshtastic-protobufs`
Update README.md 2021-07-09 04:27:25 +00:00			`[![Open in Visual Studio Code](https://open.vscode.dev/badges/open-in-vscode.svg)](https://open.vscode.dev/meshtastic/Meshtastic-protobufs)`
Update README.md add ci badge 2022-01-20 18:03:25 +00:00			`[![CI](https://github.com/meshtastic/Meshtastic-protobufs/actions/workflows/ci.yml/badge.svg)](https://github.com/meshtastic/Meshtastic-protobufs/actions/workflows/ci.yml)`
Update protobufs to autogenerate docs via protoc-gen-doc 2020-12-04 10:32:18 +00:00
Fix typo 2021-04-16 04:43:28 +00:00			`The protobuf definitions for the Meshtastic project (used by apps and the device code)`
Update protobufs to autogenerate docs via protoc-gen-doc 2020-12-04 10:32:18 +00:00
Remove docs - Moves to main repo 2021-04-15 06:56:06 +00:00			`For questions on using these protobufs please post in our [forum](meshtastic.discourse.group). We are friendly and we love people building/extending this work.`
Update protobufs to autogenerate docs via protoc-gen-doc 2020-12-04 10:32:18 +00:00
Update README.md 2021-11-23 18:44:00 +00:00			`For documentation please visit:`
			`* [Meshtastic Docs](https://meshtastic.org/docs/developers/protobufs/api).`

			`For more information on protobufs (and tools to use them with the language of your choice) see`
			`* https://developers.google.com/protocol-buffers/docs/proto3`

			`We are not placing any of these defs inside a package, because if you do the`
			`resulting nanopb version is super verbose package mesh.`

			`Protobuf build instructions:`
			`* To build java classes for reading writing:`
			`* protoc -I=. --java_out /tmp mesh.proto`

			`To generate Nanopb c code:`
Update to 0.4.4 2021-11-23 19:26:32 +00:00			`* /home/kevinh/packages/nanopb-0.4.4-linux-x86/generator-bin/protoc --nanopb_out=/tmp -I=app/src/main/proto mesh.proto`
Update README.md 2021-11-23 18:44:00 +00:00
			`Nanopb binaries available here:`
add protolint; make all files indentation consistent with 2 spaces 2021-11-30 19:45:01 +00:00			`* https://jpa.kapsi.fi/nanopb/download/ use nanopb 0.4.4`

			`To lint:`
			`* Install protolint: brew tap yoheimuta/protolint; brew install protolint`
			`* Run it from the main directory: protolint lint .`
			`* (optional) Have it fix the mundane warnings: protolint lint -fix .`
			`* See https://github.com/yoheimuta/protolint for more info`