From afb73d888cbe221778cb5194b5a574221155cc5a Mon Sep 17 00:00:00 2001 From: Brad Rydzewski Date: Tue, 10 Nov 2015 22:44:32 -0800 Subject: [PATCH] Update README.md --- README.md | 38 ++++++++++++++------------------------ 1 file changed, 14 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index c139ee21..ccf88e2e 100644 --- a/README.md +++ b/README.md @@ -22,20 +22,25 @@ Drone documentation is organized into several categories: Contributions, questions, and comments are welcomed and encouraged. Drone developers hang out in the [drone/drone](https://gitter.im/drone/drone) room on gitter. We ask that you please post your questions to [gitter](https://gitter.im/drone/drone) before creating an issue. -### Cloning, Building, Running +### Installation -If you are new to Go, make sure you [install](http://golang.org/doc/install) Go 1.5+ and [setup](http://golang.org/doc/code.html) your workspace (ie `$GOPATH`). Go programs use directory structure for package imports, therefore, it is very important you clone this project to the specified directory in your Go path: +Please see our [installation guide](http://readme.drone.io/setup/) to install the official Docker image. + +### From Source + +Install build dependencies: + +* go 1.5+ ([install guide](http://golang.org/doc/install)) +* libsqlite3 ([install script](https://github.com/drone/drone/blob/master/contrib/setup-sassc.sh)) +* sassc ([install script](https://github.com/drone/drone/blob/master/contrib/setup-sqlite.sh)) + +Clone the repository to your Go workspace: ``` git clone git://github.com/drone/drone.git $GOPATH/src/github.com/drone/drone cd $GOPATH/src/github.com/drone/drone ``` -Please ensure your local environment has the following dependencies installed. We provide scripts in the `./contrib` folder as a convenience that can be used to install: - -* libsqlite3 -* sassc - Commands to build from source: ```sh @@ -46,25 +51,10 @@ make gen # Generate code make build # Build the binary ``` -Commands for development: - -```sh -make gen_static # Generate static content -make gen_template # Generate templates from amber files -make gen_migrations # Generate embedded database migrations -make vet # Execute go vet command -make fmt # Execute go fmt command -``` - -Commands to start drone: - -```sh -drone -drone --debug # Debug mode enables more verbose logging -``` - If you are seeing slow compile times please install the following: ```sh go install github.com/mattn/go-sqlite3 ``` + +If you are having trouble building this project please reference its `.drone.yml` file. Everything you need to know about building Drone is defined in that file.