From 3f3c29355993be02ab081efaacf3d5b802bff58a Mon Sep 17 00:00:00 2001 From: Michael Date: Sat, 30 Aug 2025 22:35:14 -0700 Subject: [PATCH] reeadme: Reorder tables to show -new branches first (#1191) * Update to Readme.MD install instructions This commit changes a few things in the installation guide. I moved the the tables that have the branches and install URLs. I also added a TIP that let's users know that they can install with sunnypilot/staging-c3-new. * Update README.md with proposed changes from DevTek Added header text over the legacy branches to bring in separation and let users know they are not recommended. * bit of change * Reorganizing a bit more --------- Co-authored-by: DevTekVE --- README.md | 47 ++++++++++++++++++++++++++++++----------------- 1 file changed, 30 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 805c4b73d..7e686cef5 100644 --- a/README.md +++ b/README.md @@ -22,34 +22,24 @@ https://docs.sunnypilot.ai/ is your one stop shop for everything from features t Detailed instructions for [how to mount the device in a car](https://comma.ai/setup). ## Installation -Please refer to [Recommended Branches](#-recommended-branches) to find your preferred/supported branch. This guide will assume you want to install the latest `release-c3` branch. +Please refer to [Recommended Branches](#-recommended-branches) to find your preferred/supported branch. This guide will assume you want to install the latest `staging-c3-new` branch. + +### If you want to use our newest branches (our rewrite) +> [!TIP] +>You can see the rewrite state on our [rewrite project board](https://github.com/orgs/sunnypilot/projects/2), and to install the new branches, you can use the following links * sunnypilot not installed or you installed a version before 0.8.17? 1. [Factory reset/uninstall](https://github.com/commaai/openpilot/wiki/FAQ#how-can-i-reset-the-device) the previous software if you have another software/fork installed. 2. After factory reset/uninstall and upon reboot, select `Custom Software` when given the option. - 3. Input the installation URL per [Recommended Branches](#-recommended-branches). Example: ```release-c3.sunnypilot.ai```. + 3. Input the installation URL per [Recommended Branches](#-recommended-branches). Example: ```https://staging-c3-new.sunnypilot.ai```. 4. Complete the rest of the installation following the onscreen instructions. * sunnypilot already installed and you installed a version after 0.8.17? 1. On the comma three, go to `Settings` ▶️ `Software`. 2. At the `Download` option, press `CHECK`. This will fetch the list of latest branches from sunnypilot. 3. At the `Target Branch` option, press `SELECT` to open the Target Branch selector. - 4. Scroll to select the desired branch per Recommended Branches (see below). Example: `release-c3` + 4. Scroll to select the desired branch per Recommended Branches (see below). Example: `staging-c3-new` -| Branch | Installation URL | -|:------------:|:--------------------------------:| -| `release-c3` | https://release-c3.sunnypilot.ai | -| `staging-c3` | https://staging-c3.sunnypilot.ai | -| `dev-c3` | https://dev-c3.sunnypilot.ai | - -### If you want to use our newest branches (our rewrite) -> [!TIP] ->You can see the rewrite state on our [rewrite project board](https://github.com/orgs/sunnypilot/projects/2), and to install the new branches, you can use the following links - - -> [!IMPORTANT] -> It is recommended to [re-flash AGNOS](https://flash.comma.ai/) if you intend to downgrade from the new branches. -> You can still restore the latest sunnylink backup made on the old branches. | Branch | Installation URL | |:----------------:|:---------------------------------------------:| @@ -59,8 +49,31 @@ Please refer to [Recommended Branches](#-recommended-branches) to find your pref | `release-c3-new` | **Not yet available**. | > [!TIP] +> You can use sunnypilot/targetbranch as an install URL. Example: 'sunnypilot/staging-c3-new'. + +> [!NOTE] > Do you require further assistance with software installation? Join the [sunnypilot Discord server](https://discord.sunnypilot.com) and message us in the `#installation-help` channel. + +
+ +Older legacy branches + +### If you want to use our older legacy branches (*not recommended*) + +> [**IMPORTANT**] +> It is recommended to [re-flash AGNOS](https://flash.comma.ai/) if you intend to downgrade from the new branches. +> You can still restore the latest sunnylink backup made on the old branches. + +| Branch | Installation URL | +|:------------:|:--------------------------------:| +| `release-c3` | https://release-c3.sunnypilot.ai | +| `staging-c3` | https://staging-c3.sunnypilot.ai | +| `dev-c3` | https://dev-c3.sunnypilot.ai | + +
+ + ## 🎆 Pull Requests We welcome both pull requests and issues on GitHub. Bug fixes are encouraged.