From 8558928864d07615eaa58a7eb492c9a42cca1b50 Mon Sep 17 00:00:00 2001 From: Adeeb Shihadeh Date: Sun, 15 Dec 2024 13:36:51 -0800 Subject: [PATCH] add branch guide to the readme --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 38d32ec3b6..b0959eee5d 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,8 @@ Quick start: `bash <(curl -fsSL openpilot.comma.ai)` -To start using openpilot in a car + +Using openpilot in a car ------ To use openpilot in a car, you need four things: @@ -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 ------