aboutsummaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
authorJon Skeet <skeet@pobox.com>2008-08-14 20:33:26 +0100
committerunknown <Jon@.(none)>2008-08-14 20:33:26 +0100
commitf92c545f493dce6e5a2e378e8268c1e7b0e55a4d (patch)
tree7c2a4a78ca01c82d165c9ece810be052ff6cc691 /README.txt
downloadprotobuf-f92c545f493dce6e5a2e378e8268c1e7b0e55a4d.tar.gz
protobuf-f92c545f493dce6e5a2e378e8268c1e7b0e55a4d.tar.bz2
protobuf-f92c545f493dce6e5a2e378e8268c1e7b0e55a4d.zip
Initial commit of C# code developed before installing Git.
committer: Jon Skeet <skeet@pobox.com>
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt77
1 files changed, 77 insertions, 0 deletions
diff --git a/README.txt b/README.txt
new file mode 100644
index 00000000..71780367
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,77 @@
+Protocol Buffers - Google's data interchange format
+Copyright 2008 Google Inc.
+http://code.google.com/apis/protocolbuffers/
+
+BETA WARNING
+============
+
+This package is a beta. This means that API may change in an
+incompatible way in the future. It's unlikely that any big changes
+will be made, but we can make no promises. Expect a non-beta release
+sometime in August 2008.
+
+C++ Installation - Unix
+=======================
+
+To build and install the C++ Protocol Buffer runtime and the Protocol
+Buffer compiler (protoc) execute the following:
+
+ $ ./configure
+ $ make
+ $ make check
+ $ make install
+
+If "make check" fails, you can still install, but it is likely that
+some features of this library will not work correctly on your system.
+Proceed at your own risk.
+
+"make install" may require superuser privileges.
+
+For advanced usage information on configure and make, see INSTALL.txt.
+
+** Hint on insall location **
+
+ By default, the package will be installed to /usr/local. However,
+ on many platforms, /usr/local/lib is not part of LD_LIBRARY_PATH.
+ You can add it, but it may be easier to just install to /usr
+ instead. To do this, invoke configure as follows:
+
+ ./configure --prefix=/usr
+
+ If you already built the package with a different prefix, make sure
+ to run "make clean" before building again.
+
+** Note for Solaris users **
+
+ Solaris 10 x86 has a bug that will make linking fail, complaining
+ about libstdc++.la being invalid. We have included a work-around
+ in this package. To use the work-around, run configure as follows:
+
+ ./configure LDFLAGS=-L$PWD/src/solaris
+
+ See src/solaris/libstdc++.la for more info on this bug.
+
+C++ Installation - Windows
+==========================
+
+If you are using Micosoft Visual C++, see vsprojects/readme.txt.
+
+If you are using Cygwin or MinGW, follow the Unix installation
+instructions, above.
+
+Java and Python Installation
+============================
+
+The Java and Python runtime libraries for Protocol Buffers are located
+in the java and python directories. See the README file in each
+directory for more information on how to compile and install them.
+Note that both of them require you to first install the Protocol
+Buffer compiler (protoc), which is part of the C++ package.
+
+Usage
+=====
+
+The complete documentation for Protocol Buffers is available via the
+web at:
+
+ http://code.google.com/apis/protocolbuffers/