summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJoshua Haberman <joshua@reverberate.org>2009-08-03 17:22:03 -0700
committerJoshua Haberman <joshua@reverberate.org>2009-08-03 17:22:03 -0700
commit946dcf4a5d9e35046eb4c2bd4c31e2d4633199e0 (patch)
treedcf70b28e7b9d1c1b3e0eddc8477eef15b8b4e01 /README
parentb07b1165d30b9f23ed418505d7a4f6ecc3664794 (diff)
Fix tests (and src) such that all tests pass again.
Diffstat (limited to 'README')
-rw-r--r--README26
1 files changed, 26 insertions, 0 deletions
diff --git a/README b/README
index 10e905a..e869667 100644
--- a/README
+++ b/README
@@ -4,6 +4,32 @@ upb - a minimalist implementation of protocol buffers.
- For API documentation, see the header files.
- To build type "make".
+
+ROADMAP OF THE SOURCE
+=====================
+
+benchmark/
+ Benchmarks of upb and other protocol buffer implementations.
+descriptor/
+ Files that describe the format of Protocol Buffer "descriptors", which are
+ protocol buffers that describe the format of other protocol buffers. These
+ are used extensively inside upb.
+labs/
+ Code that is not part of upb, but contains efficiency-related experiments
+ about alternate ways of implementing things. When possible, these are
+ benchmarked by the tests in benchmark/. We also test these with the tests
+ in tests/, to ensure that the alternate implementations are actually correct.
+src/
+ The core source directory. builds into src/libupb.a.
+tests/
+ Unit tests.
+tools/
+ Command-line tools like the upb compiler.
+
+
+CONTACT
+=======
+
Author: Joshua Haberman (joshua@reverberate.org, haberman@google.com)
See LICENSE for copyright information.
generated by cgit on debian on lair
contact matthew@masot.net with questions or feedback