mirror of
https://github.com/firebase/nanopb
synced 2026-11-09 22:25:59 +05:45
Update README.md
Add minor formatting marks to make more readable. Ex: `` for `code` and ** for *italics*.
This commit is contained in:
1 parent
aee518b2b2
commit
1023743d1e
1 file changed
+8
-8
@@ -18,8 +18,8 @@ Using the nanopb library
|
||||
------------------------
|
||||
To use the nanopb library, you need to do two things:
|
||||
|
||||
1. Compile your .proto files for nanopb, using protoc.
|
||||
2. Include pb_encode.c, pb_decode.c and pb_common.c in your project.
|
||||
1. Compile your .proto files for nanopb, using `protoc`.
|
||||
2. Include *pb_encode.c*, *pb_decode.c* and *pb_common.c* in your project.
|
||||
|
||||
The easiest way to get started is to study the project in "examples/simple".
|
||||
It contains a Makefile, which should work directly under most Linux systems.
|
||||
@@ -30,23 +30,23 @@ README.txt in that folder.
|
||||
|
||||
Using the Protocol Buffers compiler (protoc)
|
||||
--------------------------------------------
|
||||
The nanopb generator is implemented as a plugin for the Google's own protoc
|
||||
The nanopb generator is implemented as a plugin for the Google's own `protoc`
|
||||
compiler. This has the advantage that there is no need to reimplement the
|
||||
basic parsing of .proto files. However, it does mean that you need the
|
||||
Google's protobuf library in order to run the generator.
|
||||
|
||||
If you have downloaded a binary package for nanopb (either Windows, Linux or
|
||||
Mac OS X version), the 'protoc' binary is included in the 'generator-bin'
|
||||
Mac OS X version), the `protoc` binary is included in the 'generator-bin'
|
||||
folder. In this case, you are ready to go. Simply run this command:
|
||||
|
||||
generator-bin/protoc --nanopb_out=. myprotocol.proto
|
||||
|
||||
However, if you are using a git checkout or a plain source distribution, you
|
||||
need to provide your own version of protoc and the Google's protobuf library.
|
||||
On Linux, the necessary packages are protobuf-compiler and python-protobuf.
|
||||
need to provide your own version of `protoc` and the Google's protobuf library.
|
||||
On Linux, the necessary packages are `protobuf-compiler` and `python-protobuf`.
|
||||
On Windows, you can either build Google's protobuf library from source or use
|
||||
one of the binary distributions of it. In either case, if you use a separate
|
||||
protoc, you need to manually give the path to nanopb generator:
|
||||
`protoc`, you need to manually give the path to nanopb generator:
|
||||
|
||||
protoc --plugin=protoc-gen-nanopb=nanopb/generator/protoc-gen-nanopb ...
|
||||
|
||||
@@ -57,7 +57,7 @@ Running the tests
|
||||
If you want to perform further development of the nanopb core, or to verify
|
||||
its functionality using your compiler and platform, you'll want to run the
|
||||
test suite. The build rules for the test suite are implemented using Scons,
|
||||
so you need to have that installed. To run the tests:
|
||||
so you need to have that installed (ex: `sudo apt install scons` on Ubuntu). To run the tests:
|
||||
|
||||
cd tests
|
||||
scons
|
||||
|
||||
Reference in new issue
Block a user