Merge pull request #235 from opencontrol/simplify-install

simplify install instructions

CONTRIBUTING.md

@@ -14,43 +14,48 @@ This project uses [glide](https://github.com/Masterminds/glide) to manage vendor
 
 ### Project setup
 
-1. Follow the [general setup steps](README.md#quick-start).
-1. Run
-
-    ```bash
-    cd $GOPATH/src/github.com/opencontrol/compliance-masonry/
-    # Build
-    go build
-
-    # (Optional) Update Dependencies
-    # Install Glide first
-    go get github.com/Masterminds/glide
-    glide up --all-dependencies
+1. Install Go 1.6+, and ensure your `GOPATH` is set. Using [gvm](https://github.com/moovweb/gvm) is recommended.
+1. Install the tool.
+
+    ```sh
+    go get github.com/opencontrol/compliance-masonry
+    compliance-masonry
     ```
 
+This should print out usage documentation. You can find the code in `$GOPATH/src/github.com/opencontrol/compliance-masonry/`.
+
 ### Running tests
 
-```bash
+```sh
 # Get test dependencies
 go get -t ./...
 # Run tests
 go test $(glide nv)
 ```
 
+### Updating dependencies
+
+Masonry uses [glide](https://github.com/Masterminds/glide) to manage dependencies.
+
+```sh
+go get github.com/Masterminds/glide
+glide up --all-dependencies
+```
+
 ### Creating Binaries
 
 #### One Time Setup for Uploading Binaries
 
 1. Install [goxc](go get github.com/laher/goxc)
 
-    ```bash
+    ```sh
     go get github.com/laher/goxc
     ```
 
 1. [Get a GitHub API token](https://github.com/settings/tokens/new). The token should have write access to repos.
 1. Add a .goxc.local.json file with a github api key
 
-    ```bash
+    ```sh
     goxc -wlc default publish-github -apikey=123456789012
     ```
 
@@ -61,7 +66,7 @@ go test $(glide nv)
     * As `app.Version` in [`masonry-go.go`](masonry-go.go)
 1. Run the release script
 
-    ```bash
+    ```sh
     ./release.sh
     ```
 

README.md

@@ -22,59 +22,37 @@ who want to use Compliance Masonry without the need to install any external
 dependencies or programs. This is extremely beneficial for those who may to
 jump right in without worrying about much technical setup.
 
-### Mac OS X Installation
-#### Technical Users - Mac OS X
+### Mac OS X
+
 In your terminal, run the following:
+
 ```sh
+cd ~/Downloads
 curl -L https://github.com/opencontrol/compliance-masonry/releases/download/v1.1.2/compliance-masonry_1.1.2_darwin_amd64.zip -o compliance-masonry.zip
 unzip compliance-masonry.zip
 cp compliance-masonry_1.1.2_darwin_amd64/compliance-masonry /usr/local/bin
 ```
 
-#### Less Technical Users - Mac OS X
-1. Go to the [Github Releases
-Page](https://github.com/opencontrol/compliance-masonry/releases).
-2. Download the package that corresponds to your machine and operating system.
-  - The following are common file endings for common systems configurations to
-  help you decide which one.
-  - For Mac OS X, you'll want the file ending `_darwin_amd64.zip`
-3. Double-click on the downloaded package to unzip the archive and it
-should result in a folder which contains a file called `compliance-masonry`.
-4. Right click on `compliance-masonry` and select `Copy`
-5. Open `Finder`
-6. In the navigation bar, click `Go` -> `Go to Folder...`
-7. Type in `/usr/local/bin` to open the `bin` folder
-8. In the navigation bar, click `Edit` -> `Paste Item`
-
-### Windows Installation
-#### Technical Users - Windows
-1. In the browser, go to the [Github Releases
-Page](https://github.com/opencontrol/compliance-masonry/releases) and download
-the zip file.
-2. Unzip it.
-3. Create a folder for the masonry binary. (e.g. `C:\Masonry\bin`)
-4. Copy the `compliance-masonry.exe` file to `C:\Masonry\bin`
-5. Open your PowerShell and run `set PATH=%PATH%;C:\Masonry\bin`.
-
-#### Less Technical Users - Windows
-1. Go to the [Github Releases
-Page](https://github.com/opencontrol/compliance-masonry/releases).
-2. Download the package that corresponds to your machine and operating system.
-  - The following are common file endings for common systems configurations to
-  help you decide which one.
-  - For 32 Bit Windows, you'll want the file ending `_windows_386.zip`
-  - For 64 Bit Windows, you'll want the file ending `_windows_amd64.zip`
-3. Double-click on the downloaded package to unzip the archive and it
-should result in a folder which contains a file called `compliance-masonry.exe`.
-4. Create a folder (e.g. `C:\Masonry\bin`) and copy `compliance-masonry.exe` into it.
-5. Follow the instructions [here](http://www.howtogeek.com/118594/how-to-edit-your-system-path-for-easy-command-line-access/)
-to add your folder (e.g. `C:\Masonry\bin`) to the `PATH` environment variable.
-(In this article, replace `C:\Android\platform-tools` with your folder, e.g. `C:\Masonry\bin`).
-
-### Linux Installation
+### Windows
+
+1. Go to [the Github Release](https://github.com/opencontrol/compliance-masonry/releases/tag/v1.1.2).
+1. Download the package that corresponds to your machine and operating system.
+    - For 32 Bit Windows, you'll want the file ending `_windows_386.zip`
+    - For 64 Bit Windows, you'll want the file ending `_windows_amd64.zip`
+1. Double-click on the downloaded package to unzip the archive. The resulting folder should contain a file called `compliance-masonry.exe`.
+1. Create a folder, e.g. `C:\Masonry\bin`.
+1. Drag `compliance-masonry.exe` into the new folder.
+1. Open PowerShell.
+    * Search your Start menu / Cortana for it.
+1. [Add `C:\Masonry\bin` to your `PATH`.](https://www.java.com/en/download/help/path.xml)
+
+### Linux
+
+The instructions below are for 64-bit architectures. See the [releases](https://github.com/opencontrol/compliance-masonry/releases) page for others.
+
 In your terminal, run the following:
+
 ```sh
-# For 64 bit Linux
 curl -L https://github.com/opencontrol/compliance-masonry/releases/download/v1.1.2/compliance-masonry_1.1.2_linux_amd64.tar.gz -o compliance-masonry.tar.gz
 tar -xf compliance-masonry.tar.gz
 cp compliance-masonry_1.1.2_linux_amd64/compliance-masonry /usr/local/bin