aboutsummaryrefslogtreecommitdiff
path: root/java/README.txt
diff options
context:
space:
mode:
authortemporal <temporal@630680e5-0e50-0410-840e-4b1c322b438d>2008-07-21 20:28:30 +0000
committertemporal <temporal@630680e5-0e50-0410-840e-4b1c322b438d>2008-07-21 20:28:30 +0000
commitcc930432c2823c3d82e0b8dd2ae4f446c82f4fce (patch)
tree034374c1b36c3acd45957c4fd294bb89d866ce02 /java/README.txt
parente8564291e29c7bb07b626ee4b0c5e99e6b2270d3 (diff)
downloadprotobuf-cc930432c2823c3d82e0b8dd2ae4f446c82f4fce.tar.gz
protobuf-cc930432c2823c3d82e0b8dd2ae4f446c82f4fce.tar.bz2
protobuf-cc930432c2823c3d82e0b8dd2ae4f446c82f4fce.zip
misc. stuff:
- Improved readmes. - Fixed incorrect definition of kint32min. - Fixed absolute output paths on Windows. - Added info to Java POM that will be required when we upload the package to a Maven repo.
Diffstat (limited to 'java/README.txt')
-rw-r--r--java/README.txt32
1 files changed, 30 insertions, 2 deletions
diff --git a/java/README.txt b/java/README.txt
index 3bb69236..050bbfe7 100644
--- a/java/README.txt
+++ b/java/README.txt
@@ -3,8 +3,11 @@ Copyright 2008 Google Inc.
This directory contains the Java Protocol Buffers runtime library.
-Installation
-============
+Installation - With Maven
+=========================
+
+The Protocol Buffers build is managed using Maven. If you would
+rather build without Maven, see the next section.
1) Install Apache Maven if you don't have it:
@@ -37,6 +40,31 @@ Installation
The .jar will be placed in the "target" directory.
+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
=====