From 2b49881d7c5671dba8f3a9fefff61a078d17b79e Mon Sep 17 00:00:00 2001 From: Brad Rydzewski Date: Mon, 18 Apr 2016 21:31:38 -0700 Subject: [PATCH] Update README.md [CI SKIP] --- README.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 34a74fd..0b7b5fb 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,31 @@ -LGTM is a simple pull request approval system using GitHub protected branches and simple MAINTAINERS files. For more informations see https://lgtm.co/docs +LGTM is a simple pull request approval system using GitHub protected branches and simple MAINTAINERS files. For more information please see the documentation https://lgtm.co/docs +## Setup + +Please see our [installation guide](https://lgtm.co/docs/install/) to install the official Docker image. + +## Build + +Clone the repository to your Go workspace: + +```sh +git clone git://github.com/drone/drone.git $GOPATH/src/github.com/drone/drone +cd $GOPATH/src/github.com/drone/drone +``` + +Commands to build from source: + +```sh +export GO15VENDOREXPERIMENT=1 + +make deps # Download required dependencies +make gen # Generate code +make build # Build the binary +``` + +## Help + +Contributions, questions, and comments are welcomed and encouraged. LGTM developers hang out in the [lgtmco/lgtm](https://gitter.im/lgtmco/lgtm) room on gitter. We ask that you please post your questions to gitter before creating an issue. + + +If you are having trouble building this project please reference its .drone.yml file. Everything you need to know about building LGTM is defined in that file.