Add binary installation instructions #232
Conversation
Current coverage is 90.12% (diff: 100%)@@ master #232 diff @@
==========================================
Files 32 32
Lines 1013 1013
Methods 0 0
Messages 0 0
Branches 0 0
==========================================
Hits 913 913
Misses 82 82
Partials 18 18
|
| #### Technical Users - Mac OS X | ||
| In your terminal, run the following: | ||
| ```sh | ||
| 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 |
There was a problem hiding this comment.
Minor: Have them cd ~/Downloads first, or rm -rf compliance-masonry_1.1.2_darwin_amd64/ after the fact.
| 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` |
There was a problem hiding this comment.
While I appreciate the sentiment behind this section, the reality is that users are going to be running Masonry from the command line anyway, so if they aren't comfortable with running those handful of commands above, they are going to have a hard time with the rest. Therefore, I would take this section out, for simplicity.
| 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`. |
There was a problem hiding this comment.
Will this stick, or do they need to run it every time they open a new shell?
| 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`). |
There was a problem hiding this comment.
Thoughts about merging the two sets of Windows instructions? Seems like they go through the same steps. Curious to hear from @brittag on this.
There was a problem hiding this comment.
Yeah, when possible I prefer writing one set of instructions for each system (with consolidated info) instead of two sets of instructions, for ease of maintenance. In my experience it's ok for more technical users to read more-detailed instructions - they'll just mentally translate to the faster advanced way to accomplish a task.
| ### Linux Installation | ||
| In your terminal, run the following: | ||
| ```sh | ||
| # For 64 bit Linux |
There was a problem hiding this comment.
Maybe say
The instructions below are for 64-bit architectures. See the releases page for others.
Might not hurt to tell them how to find out their architecture, though I actually don't know a straightforward way to do this.
| # 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 |
There was a problem hiding this comment.
Ditto with the cleanup suggestion above.
|
|
||
| ```bash | ||
| go get github.com/opencontrol/compliance-masonry | ||
| ``` |
There was a problem hiding this comment.
Maybe we should move this to the CONTRIBUTING file or something?
|
Merging now since it's an improvement (and we want the updated instructions for tomorrow)...we can address the feedback in a follow-up PR. |
|
opencontrol/freedonia-compliance#13 (comment) is why it's a good idea to direct people to stable releases 😁 |
Addresses #179
Inspired by:
https://www.terraform.io/intro/getting-started/install.html
http://gohugo.io/overview/installing/
http://gohugo.io/tutorials/installing-on-mac/
http://gohugo.io/tutorials/installing-on-windows/