summaryrefslogtreecommitdiffhomepage
path: root/BUILD.md
diff options
context:
space:
mode:
authorFUJITA Tomonori <fujita.tomonori@gmail.com>2018-12-26 06:55:08 +0900
committerFUJITA Tomonori <fujita.tomonori@gmail.com>2018-12-26 06:55:08 +0900
commitc83d234c308ce3b9f0d9e7b52ecfb84657e4e300 (patch)
tree006e917572eeab1c57834fd779ba12362ab58d29 /BUILD.md
parentd2da513e3222d9606e510ec632af180fe5991a8a (diff)
docs: add project layout description to BUILD
Signed-off-by: FUJITA Tomonori <fujita.tomonori@gmail.com>
Diffstat (limited to 'BUILD.md')
-rw-r--r--BUILD.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/BUILD.md b/BUILD.md
index 8dc9cc2c..37be4b18 100644
--- a/BUILD.md
+++ b/BUILD.md
@@ -10,7 +10,11 @@ $ go get github.com/osrg/gobgp
$ cd $GOPATH/src/github.com/osrg/gobgp && dep ensure
```
-Now ready to build two binaries, `cmd/gobgp` and `cmd/gobgpd`.
+Now ready to modify the code and build two binaries, `cmd/gobgp` and `cmd/gobgpd`.
+
+## Layout
+
+The GoBGP project adopts [Standard Go Project Layout](https://github.com/golang-standards/project-layout).
## Changing the gRPC API