diff --git a/README.md b/README.md index a2fd47a..f66c1ff 100644 --- a/README.md +++ b/README.md @@ -9,16 +9,13 @@ and here to install Qt: https://github.com/therecipe/qt ### Files: -lib - contains the gRPC protobuf definition of our service. Our service -defines one unary endpoint with an input message type and an output message -type. -lib/count.proto - the gRPC definitions, written by a human -lib/count - the Go package containing our gRPC client and server definitions -lib/count/count.pb.go - generated from lib/count.proto using the following protoc invokation: -`protoc -I count count.proto --go_out=plugins=grpc:count` - -cmd - contains our executable programs -cmd/count-client - a gRPC client with a Qt ui -cmd/count-server - a gRPC server, no graphical ui - - +- `lib` - contains the gRPC protobuf definition of our service. Our service +- defines one unary endpoint with an input message type and an output message +- type. +- `lib/count.proto` - the gRPC definitions, written by a human +- `lib/count` - the Go package containing our gRPC client and server definitions +- `lib/count/count.pb.go` - generated from lib/count.proto using the following protoc invokation: + `protoc -I count count.proto --go_out=plugins=grpc:count` +- `cmd` - contains our executable programs +- `cmd/count-client` - a gRPC client with a Qt ui +- `cmd/count-server` - a gRPC server, no graphical ui