From e601d694c0e4bd7f1508471d00581815a6472379 Mon Sep 17 00:00:00 2001
From: Cody Soyland <cody@soyland.org>
Date: Tue, 27 Mar 2018 15:02:12 -0500
Subject: [PATCH] Document Makefile

---
 CONTRIBUTING.md      | 66 ++++++++++++++++++++++++++++++++++++++++++++
 docs/installation.md |  8 ++++++
 2 files changed, 74 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 402895f1d..0a29cb1b5 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -66,6 +66,72 @@ If you want to help but you aren't sure where to start, check out our [github la
     git remote add upstream git@github.com:pilosa/pilosa.git
     ```
 
+### Makefile
+
+Pilosa includes a Makefile that automates several tasks:
+
+- Install Pilosa:
+
+    ```sh
+    make install
+    ```
+
+- Create the vendor directory:
+
+    ```sh
+    make vendor
+    ```
+
+- Run the test suite:
+
+    ```sh
+    make test
+    ```
+
+- View the coverage report:
+
+    ```sh
+    make cover-viz
+    ```
+
+- Clear the `vendor/` and `build/` directories:
+
+    ```sh
+    make clean
+    ```
+
+- Create release tarballs:
+
+    ```sh
+    make release
+    ```
+
+- Generate static assets for the WebUI:
+
+    ```sh
+    make generate-statik
+    ```
+
+- Regenerate protocol buffer files in `internal/`:
+
+    ```sh
+    make generate-protoc
+    ```
+
+- Create tagged Docker image:
+
+    ```sh
+    make docker
+    ```
+
+- Run tests inside Docker container:
+
+    ```sh
+    make docker-test
+    ```
+
+Additional commands are available in the `Makefile`.
+
 ### Submitting code changes
 
 - Before starting to work on a task, sync your branch with the upstream:
diff --git a/docs/installation.md b/docs/installation.md
index 9ca90ccf2..225e742ae 100644
--- a/docs/installation.md
+++ b/docs/installation.md
@@ -134,6 +134,10 @@ There are four ways to install Pilosa on MacOS: Use [Homebrew](https://brew.sh/)
 
 #### Build from Source
 
+<div class="note">
+    <p>For advanced instructions for building from source, view our <a href="https://github.com/pilosa/pilosa/blob/master/CONTRIBUTING.md">Contributor's Guide.</a></p>
+</div>
+
 1. Install the prerequisites:
 
     * [Go](https://golang.org/doc/install). Be sure to set the `$GOPATH` and `$PATH` environment variables as described [here](https://golang.org/doc/code.html#GOPATH).
@@ -288,6 +292,10 @@ There are three ways to install Pilosa on Linux: download the binary (recommende
 
 #### Build from Source
 
+<div class="note">
+    <p>For advanced instructions for building from source, view our <a href="https://github.com/pilosa/pilosa/blob/master/CONTRIBUTING.md">Contributor's Guide.</a></p>
+</div>
+
 1. Install the prerequisites:
 
     * [Go](https://golang.org/doc/install). Be sure to set the `$GOPATH` and `$PATH` environment variables as described [here](https://golang.org/doc/code.html#GOPATH).