Skip to content

Commit

Permalink
add branch guide to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
adeebshihadeh authored Dec 15, 2024
1 parent df2bf83 commit 8558928
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ Quick start: `bash <(curl -fsSL openpilot.comma.ai)`
</tr>
</table>

To start using openpilot in a car

Using openpilot in a car
------

To use openpilot in a car, you need four things:
Expand All @@ -49,6 +50,14 @@ To use openpilot in a car, you need four things:

We have detailed instructions for [how to install the harness and device in a car](https://comma.ai/setup). Note that it's possible to run openpilot on [other hardware](https://blog.comma.ai/self-driving-car-for-free/), although it's not plug-and-play.

### Branches
| branch | URL | description |
|------------------|----------------------------------------|-------------------------------------------------------------------------------------|
| `release3` | openilot.comma.ai | This is openpilot's release branch. |
| `release3-staging` | openpilot-test.comma.ai | This is the staging branch for releases. Use it to get new releases slightly early. |
| `nightly` | openpilot-nightly.comma.ai | This is the bleeding edge development branch. Do not expect this to be stable. |
| `nightly-dev` | installer.comma.ai/commaai/nightly-dev | Same as nightly, but includes experimental development features for some cars. |

To start developing openpilot
------

Expand Down

0 comments on commit 8558928

Please sign in to comment.