diff options
author | Petteri Aimonen <jpa@git.mail.kapsi.fi> | 2013-11-17 19:20:04 +0200 |
---|---|---|
committer | Petteri Aimonen <jpa@git.mail.kapsi.fi> | 2013-12-29 20:26:57 +0200 |
commit | ef31774cd902a6f069b8f2b80b870167328f5acb (patch) | |
tree | 321c008c224a5e197925030e1ddafcc0a88536d6 /examples/simple/README.txt | |
parent | 480b39cc0adc749ad81183fad2bfce6548c56604 (diff) |
Moving files around
Renamed READMEs to README.txt to be more friendly for Windows users.
Diffstat (limited to 'examples/simple/README.txt')
-rw-r--r-- | examples/simple/README.txt | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/examples/simple/README.txt b/examples/simple/README.txt new file mode 100644 index 00000000..d18c4183 --- /dev/null +++ b/examples/simple/README.txt @@ -0,0 +1,30 @@ +Nanopb example "simple" +======================= + +This example demonstrates the very basic use of nanopb. It encodes and +decodes a simple message. + +The code uses four different API functions: + + * pb_ostream_from_buffer() to declare the output buffer that is to be used + * pb_encode() to encode a message + * pb_istream_from_buffer() to declare the input buffer that is to be used + * pb_decode() to decode a message + +Example usage +------------- + +On Linux, simply type "make" to build the example. After that, you can +run it with the command: ./simple + +On other platforms, you first have to compile the protocol definition using +the following two commands:: + + protoc -osimple.pb simple.proto + python nanopb_generator.py simple.pb + +After that, add the following four files to your project and compile: + + simple.c simple.pb.c pb_encode.c pb_decode.c + + |