Added README

git-svn-id: https://svn.kapsi.fi/jpa/nanopb@976 e3a754e5-d11d-0410-8d38-ebb782a927b9

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..0fc79c4
--- /dev/null
+++ b/README
@@ -0,0 +1,9 @@
+Nanopb is a small code-size Protocol Buffers implementation.
+
+Homepage: http://kapsi.fi/~jpa/nanopb/
+
+To compile the library, you'll need these libraries:
+protobuf-compiler python-protobuf libprotobuf-dev
+
+To run the tests, run make under the tests folder.
+If it completes without error, everything is fine.

diff --git a/docs/reference.rst b/docs/reference.rst
index 71b934c..d67499e 100644 (file)
--- a/docs/reference.rst
+++ b/docs/reference.rst
@@ -214,7 +214,7 @@ Writes the length of a string as varint and then contents of the string. Used fo
 
     Each field encoder only encodes the contents of the field. The tag must be encoded separately with `pb_encode_tag_for_field`_.
 
-    You can use the field encoders from your callbacks. Just be aware that the pb_field_t passed to the callback is not directly compatible with most of the encoders. Instead, you must create a new pb_field_t structure and set the data_size according to the data type you pass to *src.
+    You can use the field encoders from your callbacks. Just be aware that the pb_field_t passed to the callback is not directly compatible with most of the encoders. Instead, you must create a new pb_field_t structure and set the data_size according to the data type you pass to *src*.
 
 pb_enc_varint
 -------------
@@ -376,7 +376,7 @@ Because of memory concerns, the detection of missing required fields is not perf
 
     Each field decoder reads and decodes a single value. For arrays, the decoder is called repeatedly.
 
-    You can use the decoders from your callbacks. Just be aware that the pb_field_t passed to the callback is not directly compatible with most of the field decoders. Instead, you must create a new pb_field_t structure and set the data_size according to the data type you pass to *dest.
+    You can use the decoders from your callbacks. Just be aware that the pb_field_t passed to the callback is not directly compatible with most of the field decoders. Instead, you must create a new pb_field_t structure and set the data_size according to the data type you pass to *dest*.
 
 pb_dec_varint
 -------------