Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add install instructions to README

Fixes #6, thanks for keeping me honest @soffes.

[ci skip]
  • Loading branch information...
commit 8fcc2f5ed1b696720b610e19f576a3fe915551cf 1 parent 60d417e
@pengwynn authored
Showing with 15 additions and 0 deletions.
  1. +15 −0 README.md
View
15 README.md
@@ -2,6 +2,20 @@
Check your project for common sources of contributor friction.
+### Install
+
+If you've got Go installed, you can install flint with Go's command line
+interface:
+
+```
+go get github.com/pengwynn/flint
+```
+
+You can test your installation by running `flint --version` from any folder.
+
+If you don't have Go installed, you can download a [prebuilt binary for your
+platform][releases], optionally renaming it to "flint" for convenience.
+
### Usage
Run `flint` from your project root to check for some common ways to improve the
@@ -111,3 +125,4 @@ Copyright 2014 [Wynn Netherland][pengwynn].
[octokit contrib]: https://github.com/octokit/octokit.rb/blob/master/CONTRIBUTING.md
[choose]: http://choosealicense.com/
[RDD]: http://tom.preston-werner.com/2010/08/23/readme-driven-development.html
+[releases]: https://github.com/pengwynn/flint/releases
Please sign in to comment.
Something went wrong with that request. Please try again.