summaryrefslogtreecommitdiffstats
path: root/examples/simple/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'examples/simple/README.txt')
-rw-r--r--examples/simple/README.txt30
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
+
+