Initial import of v2.0.0beta
[protobuf.git] / README.txt
blob75a429af45416ce60b3669097493dc1593982104
1 Protocol Buffers - Google's data interchange format
2 Copyright 2008 Google Inc.
3 http://code.google.com/apis/protocolbuffers/
5 BETA WARNING
6 ============
8 This package is a beta.  This means that API may change in an
9 incompatible way in the future.  It's unlikely that any big changes
10 will be made, but we can make no promises.  Expect a non-beta release
11 sometime in August 2008.
13 C++ Installation
14 ================
16 To build and install the C++ Protocol Buffer runtime and the Protocol
17 Buffer compiler (protoc) execute the following:
19   $ ./configure
20   $ make
21   $ make check
22   $ make install
24 If "make check" fails, you can still install, but it is likely that
25 some features of this library will not work correctly on your system.
26 Proceed at your own risk.
28 "make install" may require superuser privileges.
30 For advanced usage information on configure and make, see INSTALL.
32 ** Note for Solaris users **
34   Solaris 10 x86 has a bug that will make linking fail, complaining
35   about libstdc++.la being invalid.  We have included a work-around
36   in this package.  To use the work-around, run configure as follows:
38     ./configure LDFLAGS=-L$PWD/src/solaris
40   See src/solaris/libstdc++.la for more info on this bug.
42 Java and Python Installation
43 ============================
45 The Java and Python runtime libraries for Protocol Buffers are located
46 in the java and python directories.  See the README file in each
47 directory for more information on how to compile and install them.
48 Note that both of them require you to first install the Protocol
49 Buffer compiler (protoc), which is part of the C++ package.
51 Usage
52 =====
54 The complete documentation for Protocol Buffers is available via the
55 web at:
57   http://code.google.com/apis/protocolbuffers/