Skip to content

Commit

Permalink
Move install instructions above the fold
Browse files Browse the repository at this point in the history
  • Loading branch information
boyter committed Sep 2, 2019
1 parent 11fb61a commit 2679bdf
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,18 @@ If you don't like sloc cloc and code feel free to use the name `Succinct Code Co

Dual-licensed under MIT or the [UNLICENSE](http://unlicense.org).

### Install

If you are comfortable using Go and have >= 1.10 installed the usual `go get -u github.com/boyter/scc/` will install for you.

If you are looking for binaries see [Releases](https://github.com/boyter/scc/releases) for Windows, GNU/Linux and macOS for both i386 and x86_64 bit machines.

A snap install exists https://snapcraft.io/scc thanks to [Ricardo](https://feliciano.tech/). You can run `sudo snap install scc` to install it.

If you would like to assist with getting `scc` added into apt/homebrew/chocolatey/etc... please submit a PR or at least raise an issue with instructions.

### Background

Read all about how it came to be along with performance benchmarks,

- https://boyter.org/posts/sloc-cloc-code/
Expand Down Expand Up @@ -55,16 +67,6 @@ Further reading about processing files on the disk performance

- https://blog.burntsushi.net/ripgrep/

### Install

If you are comfortable using Go and have >= 1.10 installed the usual `go get -u github.com/boyter/scc/` will install for you.

If you are looking for binaries see [Releases](https://github.com/boyter/scc/releases) for Windows, GNU/Linux and macOS for both i386 and x86_64 bit machines.

A snap install exists https://snapcraft.io/scc thanks to [Ricardo](https://feliciano.tech/). You can run `sudo snap install scc` to install it.

If you would like to assist with getting `scc` added into apt/homebrew/chocolatey/etc... please submit a PR or at least raise an issue with instructions.

### Pitch

Why use `scc`?
Expand Down

0 comments on commit 2679bdf

Please sign in to comment.