# Main software repository for Duckietown

This is the main software repository for [the Duckietown project][main]. It contains all software, as well as hardware projects.

- For an introduction to the project, see the site [duckietown.org][main].
- For extensive technical documentation, please refer to [the Duckiebooks][duckiebook].

[main]: http://duckietown.org/
[duckiebook]: http://docs.duckietown.org/


#### Branches

* `master17`: Stable 2017 branch
* `master18`: Current branch
* `master19`: will start in 2019

#### Continuous integration

See [the continuous integration console](https://circleci.com/gh/duckietown/Software/).

Master is now a protected branch. [See docs here](https://github.com/blog/2051-protected-branches-and-required-status-checks).


<table>
<thead>
    <tr><td>Branch</td><td>tests</td><td></td></tr>
</thead>
<tbody>
    <tr>
        <td> <code>master18</code> </td>
        <td>
            <a href="https://circleci.com/gh/duckietown/Software/tree/master18">
                <img src='https://circleci.com/gh/duckietown/Software/tree/master18.svg?style=shield'/></a>
        </td>
        <td>Merges to master are not allowed unless the tests pass. Master will always be green. </td>
    </tr>
</tbody>
</table>