diff options
author | Petteri Aimonen <jpa@git.mail.kapsi.fi> | 2015-09-26 12:47:34 +0300 |
---|---|---|
committer | Petteri Aimonen <jpa@git.mail.kapsi.fi> | 2015-09-26 12:47:34 +0300 |
commit | 8b86c5a319c2da36cdd2b672544f7b01f3ead7d0 (patch) | |
tree | 954c7077722220c5e779f7a3f8b20fe0bcb59d98 | |
parent | 3cb3872a1adc7e8f098595cc64f3c7ac820928d7 (diff) |
Fine-tune the readme
-rw-r--r-- | README.md (renamed from README.txt) | 17 |
1 files changed, 11 insertions, 6 deletions
@@ -1,15 +1,20 @@ +Nanopb - Protocol Buffers for Embedded Systems +============================================== + +[![Build Status](https://travis-ci.org/nanopb/nanopb.svg?branch=master)](https://travis-ci.org/nanopb/nanopb) + Nanopb is a small code-size Protocol Buffers implementation in ansi C. It is especially suitable for use in microcontrollers, but fits any memory restricted system. -Homepage: http://kapsi.fi/~jpa/nanopb/ -Downloads: http://koti.kapsi.fi/~jpa/nanopb/download/ -Forum: https://groups.google.com/forum/#!forum/nanopb +* **Homepage:** http://kapsi.fi/~jpa/nanopb/ +* **Downloads:** http://koti.kapsi.fi/~jpa/nanopb/download/ +* **Forum:** https://groups.google.com/forum/#!forum/nanopb Using the nanopb library -======================== +------------------------ To use the nanopb library, you need to do two things: 1) Compile your .proto files for nanopb, using protoc. @@ -23,7 +28,7 @@ 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 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 @@ -47,7 +52,7 @@ protoc, you need to manually give the path to nanopb generator: 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, |