woodpecker/README.md

56 lines
2.4 KiB
Markdown
Raw Normal View History

2015-10-26 17:41:07 +00:00
[![Build Status](http://beta.drone.io/api/badges/drone/drone/status.svg)](http://beta.drone.io/drone/drone)
2015-10-30 20:55:50 +00:00
![Release Status](https://img.shields.io/badge/status-beta-yellow.svg?style=flat)
2015-10-30 20:47:50 +00:00
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/drone/drone?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
2015-07-10 00:01:03 +00:00
Drone is a Continuous Integration platform built on container technology. Every build is executed inside an ephemeral Docker container, giving developers complete control over their build environment with guaranteed isolation.
2015-07-10 03:15:29 +00:00
### Goals
Drone's prime directive is to help teams [ship code like GitHub](https://github.com/blog/1241-deploying-at-github#always-be-shipping). Drone is easy to install, setup and maintain and offers a powerful container-based plugin system. Drone aspires to be an industry-wide replacement for Jenkins.
### Documentation
2015-07-10 00:01:03 +00:00
Drone documentation is organized into several categories:
* [Setup Guide](http://readme.drone.io/setup/overview)
* [Build Guide](http://readme.drone.io/usage/overview)
* [Plugin Guide](http://readme.drone.io/devs/plugins)
* [CLI Reference](http://readme.drone.io/devs/cli/)
* [API Reference](http://readme.drone.io/devs/api/builds)
2015-07-10 00:01:03 +00:00
### Documentation for 0.5 (unstable)
If you are using the 0.5 unstable release (master branch) please see the updated documentation:
2016-07-10 17:40:01 +00:00
* [Setup Guide](http://readme.drone.io/0.5/installation/server/)
* [Build Guide](http://readme.drone.io/0.5/usage/overview/)
2015-08-04 17:55:27 +00:00
### Community, Help
2015-05-31 20:36:51 +00:00
2015-08-04 17:55:27 +00:00
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.
2015-08-18 17:28:07 +00:00
2015-11-11 06:44:32 +00:00
### Installation
2015-08-18 20:57:40 +00:00
Please see our [installation guide](http://readme.drone.io/setup/overview) to install the official Docker image.
2015-11-11 06:44:32 +00:00
### From Source
Clone the repository to your Go workspace:
2015-08-18 20:57:40 +00:00
```
git clone git://github.com/drone/drone.git $GOPATH/src/github.com/drone/drone
cd $GOPATH/src/github.com/drone/drone
```
2015-08-18 17:28:07 +00:00
Commands to build from source:
```sh
2015-10-08 14:06:42 +00:00
export GO15VENDOREXPERIMENT=1
make deps # Download required dependencies
make gen # Generate code
make build # Build the binary
2015-09-01 14:08:42 +00:00
```
2015-11-11 06:44:32 +00:00
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.