woodpecker/README.md

44 lines
1.8 KiB
Markdown
Raw Normal View History

> **WARNING** the 0.4 branch is very unstable. We only recommend running this branch if you plan to dig into the codebase, troubleshoot issues and contribute (please do!). We will notify the broader community once this branch is more stable.
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/docs/setup/)
* [Build Guide](http://readme.drone.io/docs/build/)
* [Plugin Guide](http://readme.drone.io/docs/plugin/)
2015-07-10 00:01:03 +00:00
* [API Reference](http://readme.drone.io/docs/api/)
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
### Building, Running
Commands to build from source:
```sh
make deps # download dependencies
make # create binary files in ./bin
make test # execute unit tests
```
Commands to start drone:
```sh
bin/drone
bin/drone --debug # debug mode loads static content from filesystem
```
2015-08-18 17:31:15 +00:00
If you are seeing slow compile times please install the following:
2015-08-18 17:28:07 +00:00
```sh
go install github.com/drone/drone/Godeps/_workspace/src/github.com/mattn/go-sqlite3
```