diff options
| -rw-r--r-- | Makefile.am | 2 | ||||
| -rw-r--r-- | README.md (renamed from README.txt) | 47 |
2 files changed, 32 insertions, 17 deletions
diff --git a/Makefile.am b/Makefile.am index 09b92ead..24e5e55c 100644 --- a/Makefile.am +++ b/Makefile.am @@ -38,7 +38,7 @@ pkgconfig_DATA = protobuf.pc protobuf-lite.pc EXTRA_DIST = \ autogen.sh \ generate_descriptor_proto.sh \ - README.txt \ + README.md \ INSTALL.txt \ LICENSE \ CONTRIBUTORS.txt \ @@ -1,17 +1,32 @@ Protocol Buffers - Google's data interchange format +=================================================== + Copyright 2008 Google Inc. + https://developers.google.com/protocol-buffers/ C++ Installation - Unix -======================= +----------------------- + +If you get the source from github, you need to generate the configure script +first: + + $ ./autogen.sh + +This will download gtest source (which is used for C++ Protocol Buffer +unit-tests) to the current directory and run automake, autoconf, etc. +to generate the configure script and various template makefiles. + +You can skip this step if you are using a release package (which already +contains gtest and the configure script). To build and install the C++ Protocol Buffer runtime and the Protocol Buffer compiler (protoc) execute the following: - $ ./configure - $ make - $ make check - $ make install + $ ./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. @@ -21,7 +36,7 @@ Proceed at your own risk. For advanced usage information on configure and make, see INSTALL.txt. -** Hint on install location ** +**Hint on install 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. @@ -33,7 +48,7 @@ For advanced usage information on configure and make, see INSTALL.txt. If you already built the package with a different prefix, make sure to run "make clean" before building again. -** Compiling dependent packages ** +**Compiling dependent packages** To compile a package that uses Protocol Buffers, you need to pass various flags to your compiler and linker. As of version 2.2.0, @@ -71,7 +86,7 @@ For advanced usage information on configure and make, see INSTALL.txt. If you only want protobuf-lite, substitute "protobuf-lite" in place of "protobuf" in these examples. -** Note for cross-compiling ** +**Note for cross-compiling** The makefiles normally invoke the protoc executable that they just built in order to build tests. When cross-compiling, the protoc @@ -94,7 +109,7 @@ For advanced usage information on configure and make, see INSTALL.txt. has the same version as the protobuf source code you are trying to use it with. -** Note for Solaris users ** +**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 @@ -104,7 +119,7 @@ For advanced usage information on configure and make, see INSTALL.txt. See src/solaris/libstdc++.la for more info on this bug. -** Note for HP C++ Tru64 users ** +**Note for HP C++ Tru64 users** To compile invoke configure as follows: @@ -113,7 +128,7 @@ For advanced usage information on configure and make, see INSTALL.txt. Also, you will need to use gmake instead of make. C++ Installation - Windows -========================== +-------------------------- If you are using Microsoft Visual C++, see vsprojects/readme.txt. @@ -121,7 +136,7 @@ If you are using Cygwin or MinGW, follow the Unix installation instructions, above. Binary Compatibility Warning -============================ +---------------------------- Due to the nature of C++, it is unlikely that any two versions of the Protocol Buffers C++ runtime libraries will have compatible ABIs. @@ -132,10 +147,10 @@ immediately on startup of your app. Still, you may want to consider using static linkage. You can configure this package to install static libraries only using: - ./configure --disable-shared + ./configure --disable-shared 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 @@ -144,9 +159,9 @@ 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: - https://developers.google.com/protocol-buffers/ + https://developers.google.com/protocol-buffers/ |