| 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 | |
| 4 | This directory contains the Java Protocol Buffers runtime library. |
| 5 | |
| 6 | Installation |
| 7 | ============ |
| 8 | |
| 9 | 1) Install Apache Maven if you don't have it: |
| 10 | |
| 11 | http://maven.apache.org/ |
| 12 | |
| 13 | 2) Build the C++ code, or obtain a binary distribution of protoc. If |
| 14 | you install a binary distribution, make sure that it is the same |
| 15 | version as this package. If in doubt, run: |
| 16 | |
| 17 | $ protoc --version |
| 18 | |
| 19 | You will need to place the protoc executable in ../src. (If you |
| 20 | built it yourself, it should already be there.) |
| 21 | |
| 22 | 3) Run the tests: |
| 23 | |
| 24 | $ mvn test |
| 25 | |
| 26 | If some tests fail, this library may not work correctly on your |
| 27 | system. Continue at your own risk. |
| 28 | |
| 29 | 4) Install the library into your Maven repository: |
| 30 | |
| 31 | $ mvn install |
| 32 | |
| 33 | 5) If you do not use Maven to manage your own build, you can build a |
| 34 | .jar file to use: |
| 35 | |
| 36 | $ mvn package |
| 37 | |
| 38 | The .jar will be placed in the "target" directory. |
| 39 | |
| 40 | Usage |
| 41 | ===== |
| 42 | |
| 43 | The complete documentation for Protocol Buffers is available via the |
| 44 | web at: |
| 45 | |
| 46 | http://code.google.com/apis/protocolbuffers/ |