diff options
| author | Josh Haberman <jhaberman@gmail.com> | 2014-09-01 15:34:14 -0700 |
|---|---|---|
| committer | Josh Haberman <jhaberman@gmail.com> | 2014-09-01 15:34:14 -0700 |
| commit | 66a74a4fd53710aaf54a01f668d6a895f9266fbd (patch) | |
| tree | 7f30313d002eeb5f59a16270f99edb87541adaaf /README | |
| parent | 2ccbe04559f8a954f0c0c1a54005e6e26fbf43bf (diff) | |
Added lua and core32 Travis builds, and rewrote README.md
Diffstat (limited to 'README')
| -rw-r--r-- | README | 69 |
1 files changed, 0 insertions, 69 deletions
@@ -1,69 +0,0 @@ - -upb - a small, low-level protocol buffer library - -BUILDING -======== - -To build (the core library is ANSI C99 and has no dependencies): -$ make - -Other useful targets: -$ make test -$ make benchmark -$ make lua (requires lua libraries to be installed) - -The tests and benchmarks have the following dependencies -(Ubuntu package names in parentheses): -- Google's protobuf compiler + libraries (protobuf-compiler, libprotobuf-dev) -- Lua binary and libraries (lua5.1, liblua5.1-dev) - -Issue tracking is on Google Code: - http://code.google.com/p/upb/issues/list - -A manual is forthcoming, for now see wiki docs at: - https://github.com/haberman/upb/wiki - -API -=== - -The public C/C++ API is defined by all of the .h files in upb/ except .int.h -files (which are internal-only). - -The .h files define both C and C++ APIs. Both languages have 100% complete and -first-class APIs. The C++ API is a wrapper around the C API, but all of the -wrapping is done in inline methods in .h files, so there is no overhead to this. - -For a more detailed description of the scheme we use to provide both C and C++ -APIs, see: https://github.com/haberman/upb/wiki/CAndCPlusPlusAPI - -All of the code that is under upb/ but *not* under upb/bindings/ forms the -namespace of upb's cross-language public API. For example, the code in -upb/descriptor would be exposed as follows: - - * in C/C++: - #include "upb/descriptor/X.h" - - * in Lua: - require "upb.descriptor" - - * in Python: - import upb.descriptor - - * etc. - -STABILITY / STATUS -================== - -API and ABI are both subject to change! Please do not distribute as a shared -library for this reason (for now at least). - -Parsing is becoming stable, but serialization is in very early stages. - -The Python bindings are completely broken and Lua only supports schemas for the -moment. - -CONTACT -======= - -Author: Josh Haberman (jhaberman@gmail.com, haberman@google.com) -See LICENSE for copyright information. |