| temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 1 | Protocol Buffers - Google's data interchange format |
| 2 | Copyright 2008 Google Inc. |
| 3 | http://code.google.com/apis/protocolbuffers/ |
| 4 | |
| 5 | BETA WARNING |
| 6 | ============ |
| 7 | |
| 8 | This package is a beta. This means that API may change in an |
| temporal | a44f3c3 | 2008-08-15 18:32:02 +0000 | [diff] [blame] | 9 | incompatible way in the future (however, the wire format will *not* |
| 10 | change). It's unlikely that any big changes will be made, but we can |
| 11 | make no promises. Expect a non-beta release in late August 2008. |
| temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 12 | |
| temporal | cc93043 | 2008-07-21 20:28:30 +0000 | [diff] [blame] | 13 | C++ Installation - Unix |
| 14 | ======================= |
| temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 15 | |
| 16 | To build and install the C++ Protocol Buffer runtime and the Protocol |
| 17 | Buffer compiler (protoc) execute the following: |
| 18 | |
| 19 | $ ./configure |
| 20 | $ make |
| 21 | $ make check |
| 22 | $ make install |
| 23 | |
| 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. |
| 27 | |
| 28 | "make install" may require superuser privileges. |
| 29 | |
| temporal | cc93043 | 2008-07-21 20:28:30 +0000 | [diff] [blame] | 30 | For advanced usage information on configure and make, see INSTALL.txt. |
| 31 | |
| 32 | ** Hint on insall location ** |
| 33 | |
| 34 | By default, the package will be installed to /usr/local. However, |
| 35 | on many platforms, /usr/local/lib is not part of LD_LIBRARY_PATH. |
| 36 | You can add it, but it may be easier to just install to /usr |
| 37 | instead. To do this, invoke configure as follows: |
| 38 | |
| 39 | ./configure --prefix=/usr |
| 40 | |
| 41 | If you already built the package with a different prefix, make sure |
| 42 | to run "make clean" before building again. |
| temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 43 | |
| 44 | ** Note for Solaris users ** |
| 45 | |
| 46 | Solaris 10 x86 has a bug that will make linking fail, complaining |
| 47 | about libstdc++.la being invalid. We have included a work-around |
| 48 | in this package. To use the work-around, run configure as follows: |
| 49 | |
| 50 | ./configure LDFLAGS=-L$PWD/src/solaris |
| 51 | |
| 52 | See src/solaris/libstdc++.la for more info on this bug. |
| 53 | |
| temporal | cc93043 | 2008-07-21 20:28:30 +0000 | [diff] [blame] | 54 | C++ Installation - Windows |
| 55 | ========================== |
| 56 | |
| 57 | If you are using Micosoft Visual C++, see vsprojects/readme.txt. |
| 58 | |
| 59 | If you are using Cygwin or MinGW, follow the Unix installation |
| 60 | instructions, above. |
| 61 | |
| temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 62 | Java and Python Installation |
| 63 | ============================ |
| 64 | |
| 65 | The Java and Python runtime libraries for Protocol Buffers are located |
| 66 | in the java and python directories. See the README file in each |
| 67 | directory for more information on how to compile and install them. |
| 68 | Note that both of them require you to first install the Protocol |
| 69 | Buffer compiler (protoc), which is part of the C++ package. |
| 70 | |
| 71 | Usage |
| 72 | ===== |
| 73 | |
| 74 | The complete documentation for Protocol Buffers is available via the |
| 75 | web at: |
| 76 | |
| 77 | http://code.google.com/apis/protocolbuffers/ |