Skip to content

Commit

Permalink
Add some more Markdown annotations.
Browse files Browse the repository at this point in the history
  • Loading branch information
dsymonds committed Dec 7, 2015
1 parent 44fa767 commit 68415e7
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
Go support for Protocol Buffers - Google's data interchange format
# Go support for Protocol Buffers

Google's data interchange format.
Copyright 2010 The Go Authors.
https://github.com/golang/protobuf

Expand All @@ -20,8 +22,7 @@ To use this software, you must:
for details or, if you are using gccgo, follow the instructions at
https://golang.org/doc/install/gccgo
- Grab the code from the repository and install the proto package.
The simplest way is to run
go get -u github.com/golang/protobuf/{proto,protoc-gen-go}
The simplest way is to run `go get -u github.com/golang/protobuf/{proto,protoc-gen-go}`.
The compiler plugin, protoc-gen-go, will be installed in $GOBIN,
defaulting to $GOPATH/bin. It must be in your $PATH for the protocol
compiler, protoc, to find it.
Expand Down Expand Up @@ -102,6 +103,7 @@ for a protocol buffer variable v:

Consider file test.proto, containing

```proto

This comment has been minimized.

Copy link
@dmitshur

dmitshur Dec 7, 2015

If you're going to use a fenced code block, the code inside should no longer be indented by a tab.

package example;
enum FOO { X = 17; };
Expand All @@ -114,9 +116,11 @@ Consider file test.proto, containing
required string RequiredField = 5;
}
}
```

To create and play with a Test object from the example package,

```go
package main

import (
Expand Down Expand Up @@ -149,7 +153,7 @@ To create and play with a Test object from the example package,
}
// etc.
}

```

## Parameters ##

Expand Down

0 comments on commit 68415e7

Please sign in to comment.