浏览代码

Add doc.go

The doc.go file in the proto package allows protobuild to find all protobuf
packages in the project and compile the protos.

Signed-off-by: Michael Crosby <[email protected]>
Michael Crosby 5 年之前
父节点
当前提交
a4b0259456
共有 2 个文件被更改,包括 34 次插入0 次删除
  1. 6 0
      README.md
  2. 28 0
      backend/v1/doc.go

+ 6 - 0
README.md

@@ -4,3 +4,9 @@
 
 
 To setup a development machine to update the API protobufs, first run the `./setup-dev.sh` script
 To setup a development machine to update the API protobufs, first run the `./setup-dev.sh` script
 to install the correct version of protobufs on your system and get the protobuild binary.
 to install the correct version of protobufs on your system and get the protobuild binary.
+
+## Building the API Project
+
+```bash
+> make
+```

+ 28 - 0
backend/v1/doc.go

@@ -0,0 +1,28 @@
+/*
+	Copyright (c) 2019 Docker Inc.
+
+	Permission is hereby granted, free of charge, to any person
+	obtaining a copy of this software and associated documentation
+	files (the "Software"), to deal in the Software without
+	restriction, including without limitation the rights to use, copy,
+	modify, merge, publish, distribute, sublicense, and/or sell copies
+	of the Software, and to permit persons to whom the Software is
+	furnished to do so, subject to the following conditions:
+
+	The above copyright notice and this permission notice shall be
+	included in all copies or substantial portions of the Software.
+
+	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+	EXPRESS OR IMPLIED,
+	INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+	IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+	HOLDERS BE LIABLE FOR ANY CLAIM,
+	DAMAGES OR OTHER LIABILITY,
+	WHETHER IN AN ACTION OF CONTRACT,
+	TORT OR OTHERWISE,
+	ARISING FROM, OUT OF OR IN CONNECTION WITH
+	THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+
+package v1