Code

Add the presentation slides for the intro and gRPC talks.
[go-talk.git] / README
1        tokkee's Go and gRPC talks
2       ============================
4   Supporting material for tokkee's talks about Go and gRPC.
6 Setup
7 -----
9   Set up the Go workspace in a directory of your choice (<...>):
11     $ export GOPATH=<...>
12     $ export PATH=$GOPATH/bin:$PATH
14   Get the source:
16     $ go get -u tokkee.org/go-talk/grpc/...
18   Install the program binaries:
20     $ go install tokkee.org/go-talk/grpc/server
21     $ go install tokkee.org/go-talk/grpc/client
22     $ go install tokkee.org/go-talk/grpc/ui
24 Testing
25 -------
27   The programs come with a set of sample integration tests which will spin up
28   test instances of the respective tools and run queries against them.
30   Run all tests:
32     $ go test tokkee.org/go-talk/grpc/integration/...
34 Rebuilding the generated proto / gRPC code
35 ------------------------------------------
37   Install protoc from https://github.com/google/protobuf/. We need version 3.
39   Install the Go gRPC generator plugin:
41     $ go get github.com/golang/protobuf/protoc-gen-go
43   Rebuild the code:
45     $ cd $GOPATH
46     $ protoc src/tokkee.org/go-talk/grpc/proto/backend/backend.proto \
47           --go_out=plugins=grpc:.
49 Presentation slides
50 -------------------
52   The 'tex' subdirectory includes the LaTeX code for the presentation slides.
54   Generate PDF documents:
56     $ cd $GOPATH/src/tokkee.org/go-talk
57     $ git submodule update --init
58     $ cd tex; make
60 Author
61 ------
63   Sebastian 'tokkee' Harl <sh@tokkee.org>
65   Licensed under the 2-clause BSD license. See LICENSE for details.
67   For license conditions of subpackages, see the respective LICENSE files in
68   the subdirectories.