From 1d4e5e21b64f094aa359ef59dee4a557093b100a Mon Sep 17 00:00:00 2001 From: Herman Schaaf Date: Thu, 4 Feb 2016 19:58:53 +0800 Subject: [PATCH 1/2] Update readme --- README.md | 40 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 39 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 40d516d..d9f1b0f 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,42 @@ # Go Report Card -A web application that generates a report on the quality of an open source go project. It uses several measures, including `gofmt`, `go vet`, `go lint` and `gocyclo`. +A web application that generates a report on the quality of an open source go project. It uses several measures, including `gofmt`, `go vet`, `go lint` and `gocyclo`. To get a report on your own project, try using the hosted version of this code running at [goreportcard.com](http://goreportcard.com). Currently this is limited to projects hosted on Github, but there is an [open issue](https://github.com/gojp/goreportcard/issues/51) to support all publicly hosted repos. + +### Installation + +Assuming you already have a recent version of Go installed, pull down the code with `go get`: + +``` +go get github.com/gojp/goreportcard +``` + +Go into the source directory and pull down the project dependencies: + +``` +cd $GOPATH/src/github.com/gojp/goreportcard +go get ./... +``` + +Now run main.go, + +``` +go run main.go +``` + +and you should see + +``` +Running on 127.0.0.1:8080... +``` + +Navigate to that URL in your browser and check that you can see the front page. + + +### Contributing + +Goreportcard is an open source project run by volunteers, and contributions are welcome! Check out the [Issues](https://github.com/gojp/goreportcard/issues) page to see if your idea for a contribution has already been mentioned, and feel free to raise an issue or submit a pull request. + +### License + +The code is licensed under the permissive Apache v2.0 licence. This means you can do what you like with the software, as long as you include the required notices. [Read this](https://tldrlegal.com/license/apache-license-2.0-(apache-2.0)) for a summary. From 4c4d5bb7cc4c508fe52c8a7f6730b0754b4e80d4 Mon Sep 17 00:00:00 2001 From: Herman Schaaf Date: Thu, 4 Feb 2016 20:00:44 +0800 Subject: [PATCH 2/2] Ignore .DS_Store --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index c27405f..f7ed1d4 100644 --- a/.gitignore +++ b/.gitignore @@ -24,4 +24,5 @@ _testmain.go *.prof *.swp +*.DS_Store repos