aboutsummaryrefslogtreecommitdiff
path: root/examples/README.txt
diff options
context:
space:
mode:
authorFeng Xiao <xfxyjwf@gmail.com>2017-09-08 15:44:09 -0700
committerFeng Xiao <xfxyjwf@gmail.com>2017-09-08 16:01:49 -0700
commit74bf45f379b35e1d103940f35d7a04545b0235d4 (patch)
treed3fae8b44d416796e0bc36351271bb1379d27091 /examples/README.txt
parent2ad5c0a86443f567241e0295c313baf4f0e15379 (diff)
downloadprotobuf-74bf45f379b35e1d103940f35d7a04545b0235d4.tar.gz
protobuf-74bf45f379b35e1d103940f35d7a04545b0235d4.tar.bz2
protobuf-74bf45f379b35e1d103940f35d7a04545b0235d4.zip
Add bazel support for examples.
The example utilizes native bazel rules (proto_library, cc_proto_library, java_proto_library, java_lite_proto_library) to show how easy it is to build protobuf with bazel's native support. It also makes use of well known types which was not possible until the latest bazel 0.5.4 release and https://github.com/google/protobuf/pull/3594 .
Diffstat (limited to 'examples/README.txt')
-rw-r--r--examples/README.txt61
1 files changed, 0 insertions, 61 deletions
diff --git a/examples/README.txt b/examples/README.txt
deleted file mode 100644
index 2e4f6e4e..00000000
--- a/examples/README.txt
+++ /dev/null
@@ -1,61 +0,0 @@
-This directory contains example code that uses Protocol Buffers to manage an
-address book. Two programs are provided, each with three different
-implementations, one written in each of C++, Java, and Python. The add_person
-example adds a new person to an address book, prompting the user to input
-the person's information. The list_people example lists people already in the
-address book. The examples use the exact same format in all three languages,
-so you can, for example, use add_person_java to create an address book and then
-use list_people_python to read it.
-
-You must install the protobuf package before you can build these.
-
-To build all the examples (on a unix-like system), simply run "make". This
-creates the following executable files in the current directory:
- add_person_cpp list_people_cpp
- add_person_java list_people_java
- add_person_python list_people_python
-
-If you only want to compile examples in one language, use "make cpp"*,
-"make java", or "make python".
-
-All of these programs simply take an address book file as their parameter.
-The add_person programs will create the file if it doesn't already exist.
-
-These examples are part of the Protocol Buffers tutorial, located at:
- https://developers.google.com/protocol-buffers/docs/tutorials
-
-* Note that on some platforms you may have to edit the Makefile and remove
-"-lpthread" from the linker commands (perhaps replacing it with something else).
-We didn't do this automatically because we wanted to keep the example simple.
-
-## Java ##
-
-protobuf-java-*.jar can be generated by:
- cd ../java
- mvn package
-and will be used by "make java"
-
-## Go ##
-
-The Go example requires a plugin to the protocol buffer compiler, so it is not
-build with all the other examples. See:
- https://github.com/golang/protobuf
-for more information about Go protocol buffer support.
-
-First, install the Protocol Buffers compiler (protoc).
-Then, install the Go Protocol Buffers plugin
-($GOPATH/bin must be in your $PATH for protoc to find it):
- go get github.com/golang/protobuf/protoc-gen-go
-
-Build the Go samples in this directory with "make go". This creates the
-following executable files in the current directory:
- add_person_go list_people_go
-To run the example:
- ./add_person_go addressbook.data
-to add a person to the protocol buffer encoded file addressbook.data. The file
-is created if it does not exist. To view the data, run:
- ./list_people_go addressbook.data
-
-Observe that the C++, Python, and Java examples in this directory run in a
-similar way and can view/modify files created by the Go example and vice
-versa.