diff options
author | Jesse Frankley <numberten@users.noreply.github.com> | 2015-03-16 14:41:57 -0700 |
---|---|---|
committer | Jesse Frankley <numberten@users.noreply.github.com> | 2015-03-16 14:41:57 -0700 |
commit | bf0559265298082f5e7c4cbfb3178ab82b133676 (patch) | |
tree | 1f86acf115ad7d41b84df20e796e7c70ee1b6024 /java/README.txt | |
parent | 8e2a377fab85af2d446310eed5c219e1cdda0c10 (diff) | |
download | protobuf-bf0559265298082f5e7c4cbfb3178ab82b133676.tar.gz protobuf-bf0559265298082f5e7c4cbfb3178ab82b133676.tar.bz2 protobuf-bf0559265298082f5e7c4cbfb3178ab82b133676.zip |
Rename README.txt to README.md
Diffstat (limited to 'java/README.txt')
-rw-r--r-- | java/README.txt | 96 |
1 files changed, 0 insertions, 96 deletions
diff --git a/java/README.txt b/java/README.txt deleted file mode 100644 index 57e26a96..00000000 --- a/java/README.txt +++ /dev/null @@ -1,96 +0,0 @@ -Protocol Buffers - Google's data interchange format -Copyright 2008 Google Inc. - -This directory contains the Java Protocol Buffers runtime library. - -Installation - With Maven -========================= - -The Protocol Buffers build is managed using Maven. If you would -rather build without Maven, see below. - -1) Install Apache Maven if you don't have it: - - http://maven.apache.org/ - -2) Build the C++ code, or obtain a binary distribution of protoc. If - you install a binary distribution, make sure that it is the same - version as this package. If in doubt, run: - - $ protoc --version - - You will need to place the protoc executable in ../src. (If you - built it yourself, it should already be there.) - -3) Run the tests: - - $ mvn test - - If some tests fail, this library may not work correctly on your - system. Continue at your own risk. - -4) Install the library into your Maven repository: - - $ mvn install - -5) If you do not use Maven to manage your own build, you can build a - .jar file to use: - - $ mvn package - - The .jar will be placed in the "target" directory. - -Installation - 'Lite' Version - With Maven -========================================== - -Building the 'lite' version of the Java Protocol Buffers library is -the same as building the full version, except that all commands are -run using the 'lite' profile. (see -http://maven.apache.org/guides/introduction/introduction-to-profiles.html) - -E.g. to install the lite version of the jar, you would run: - - $ mvn install -P lite - -The resulting artifact has the 'lite' classifier. To reference it -for dependency resolution, you would specify it as: - - <dependency> - <groupId>com.google.protobuf</groupId> - <artifactId>protobuf-java</artifactId> - <version>${version}</version> - <classifier>lite</classifier> - </dependency> - -Installation - Without Maven -============================ - -If you would rather not install Maven to build the library, you may -follow these instructions instead. Note that these instructions skip -running unit tests. - -1) Build the C++ code, or obtain a binary distribution of protoc. If - you install a binary distribution, make sure that it is the same - version as this package. If in doubt, run: - - $ protoc --version - - If you built the C++ code without installing, the compiler binary - should be located in ../src. - -2) Invoke protoc to build DescriptorProtos.java: - - $ protoc --java_out=src/main/java -I../src \ - ../src/google/protobuf/descriptor.proto - -3) Compile the code in src/main/java using whatever means you prefer. - -4) Install the classes wherever you prefer. - -Usage -===== - -The complete documentation for Protocol Buffers is available via the -web at: - - https://developers.google.com/protocol-buffers/ |