Merge pull request #33 from taku-k/feat/add-development

Add a description about development
hatena · Oct 17, 2017 · 4c4741d · 4c4741d
2 parents 9da08f1 + 08ca9f0
commit 4c4741d
Showing 1 changed file with 32 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -11,6 +11,38 @@ IPDrawer is IP Address Management (IPAM) application and the code is written in
 * [REST API Reference](/pkg/server/apiclient/README.md)
 * `./ipdrawer start --redis-host localhost` and access to `http://localhost:25577/swagger-ui`
 
+## Development
+
+### Prerequisite
+
+* Go
+* make
+* dep
+
+```bash
+$ make deps
+$ dep ensure
+```
+
+### Generate a binary
+
+```bash
+$ make
+$ ./ipdrawer --help
+```
+
+### Generate proto files
+
+```bash
+$ make proto
+```
+
+### Run test
+
+```bash
+$ make test
+```
+
 ## Author
 
 [taku-k](https://github.com/taku-k)