wip

README.md

@@ -21,7 +21,7 @@ FrogPilot is a fully open-sourced fork of openpilot, featuring clear and concise
 ------
 FrogPilot was last updated on:
 
-**March 29th, 2024**
+**May 1st, 2024**
 
 Features
 ------
@@ -31,17 +31,17 @@ FrogPilot offers a wide range of customizable features that are easily toggled o
 ------
 ⚡ **Advanced Customizations:**
 
-  - Adjust the max set speed in increments of 5 or more on short presses
-  - "Alert Volume Controller" to customize the volume level for all of openpilot's sound files
+  - "Alert Volume Controller" to set the volume level for each of of openpilot's sounds
   - Customize the following distance and jerk values for each personality profile
-  - Increase the stopping distance behind stopped cars
-  - Select between various openpilot driving models
-  - Set a custom "Steer Ratio" to fine tune your lateral control
+  - Fine tune your car's "Steer Ratio" to perfect your lateral control
+  - Increase the distance when stopped behind lead vehicles
+  - Increase the max set speed by a custom interval (i.e. 2, 3, 4, 5, 6, etc. instead of just 1)
+  - Select between past, present, and future openpilot driving models
 ------
 🎨 **Custom Themes:**
 
   - 🐸 Frog theme (with a bonus 🐐 sound effect)
-  - <img src="https://images.emojiterra.com/google/noto-emoji/unicode-15/color/512px/1f1f7-1f1fa.png" width="20" height="18"> Russia / Joseph Stalin theme
+  - <img src="https://images.emojiterra.com/google/noto-emoji/unicode-15/color/512px/1f1f7-1f1fa.png" width="15" height="12"> Russia / Joseph Stalin theme
   - 🔌 Tesla theme
   - Holiday themes! Minor holidays last a day, while major holidays (Easter, Halloween, Thanksgiving, Christmas) last a week
   - Random events triggered by specific actions while driving with openpilot
@@ -51,10 +51,10 @@ FrogPilot offers a wide range of customizable features that are easily toggled o
 🚀 **Conditional Experimental Mode:**
 
   - Auto-activates "Experimental Mode" under several conditions, including:
+    - Approaching intersections and turns while using navigation
     - Approaching slower vehicles to take advantage of "Experimental Mode"'s smoother braking
     - Curve and stop light/stop sign detection
     - Driving below a set speed
-    - Prepare for upcoming intersections and turns while using navigation
     - Turn signal activation below 55mph for turn assistance
 ------
 📊 **Developer UI:**
@@ -67,32 +67,33 @@ FrogPilot offers a wide range of customizable features that are easily toggled o
 🛠 **Device Management:**
 
   - Adjustable screen brightness for both onroad and offroad states
-  - Adjustable screen timeout threshold for both onroad and offroad states
-  - Backup and restore previous versions of FrogPilot versions
+  - Adjustable screen timeout times for both onroad and offroad states
+  - Backup and restore previous versions of FrogPilot
   - Backup and restore previous versions of toggle configurations
+  - Battery level threshold to automatically shut the device down after you car's battery falls below a set voltage limit when offroad
   - Delete stored driving data for increased privacy/space via the "Device" panel
   - Device can operate offline indefinitely
   - Disable logging and/or uploading
   - Disable uploads while onroad to help reduce data usage
-  - Easy Panda firmware flashing via a "Flash Panda" button in the "Device" menu
-  - Set a battery level threshold to automatically shut the device down after you car's battery falls below a specific voltage when offroad
-  - Set a timer to automatically shut the device down after going offroad to help prevent battery drain
-  - "Standby Mode" that wakes up the screen between engagement states or when important alerts are triggered
+  - Flash the Panda within the "Device" menu
+  - "Standby Mode" that wakes the screen up between engagement states or when important alerts are triggered
+  - Timer to automatically shut down after going offroad
 ------
 🚖 **Lateral Adjustments:**
 
   - Activate lateral control by simply pressing the "Cruise Control" button
-  - Force comma's auto tuning for smoother steering control
+  - Force comma's auto tuning for unsupported vehicles
   - Lateral control won't disengage on gas or brake
   - Nudgeless lane changes with lane detection to prevent driving into curbs or going offroad
   - Pause lateral control when below a set speed
+  - Pause lateral control when pressing the brake
   - Pause lateral control when turn signals are active
-  - Precise turns using turn desires when below the minimum lane change speed
+  - Precise turns by using turn desires when below the minimum lane change speed
   - [Twilsonco's NNFF](https://github.com/twilsonco/openpilot) for smoother steering control
 ------
 🚘 **Longitudinal Adjustments:**
 
-  - Aggressive acceleration following a lead vehicle from a stop
+  - Aggressive acceleration when following a lead vehicle from a stop
   - "Map Turn Speed Controller" to slow down for curves based on stored map data
     - With an additional toggle to fine tune the speed aggressiveness
   - Smoother braking behind slower leads
@@ -119,10 +120,10 @@ FrogPilot offers a wide range of customizable features that are easily toggled o
   - Compass that rotates according to the direction you're driving
   - FPS counter in the screen's border
   - Hide various UI elements on the screen for a cleaner UI
-  - Pedals on the onroad UI that indicate when the gas/brake pedals are being used
+  - Pedals on the onroad UI indicate when the gas/brake pedals are being used
   - Road UI Customizations:
     - Acceleration path to show the model's desired acceleration/deceleration
-    - Blind spot path to indicate when and where a vehicle is in your blind spot
+    - Blind spot path when a vehicle is detected in your blind spot
     - Increase/decrease the lane line, path, and road edge widths
     - Path edge colors based on specific driving statuses:
       - 🔵 Blue - Navigation active
@@ -150,12 +151,14 @@ FrogPilot offers a wide range of customizable features that are easily toggled o
   - openpilot longitudinal control for GM vehicles without ACC
   - Pedal interceptor support for GM vehicles
   - "Stop and Go" hack for Toyota's without stop and go functionality
-  - ZSS support for the Toyota Prius
+  - ZSS support for the Toyota Prius and Sienna
 ------
 🚦 **Quality of Life Features:**
 
-  - Camera view selection (cosmetic only)
-  - Custom alerts such as for a green light, vehicle in blindspot, lead departing, and the current speed limit changing
+  - Automatic updates for a completely "set and forget" experience
+  - Camera view selection
+  - Custom alerts for green lights, vehicles in blindspot, lead departing, and the current speed limit changing
+  - Display the driver camera when in reverse
   - Driving statistics to show how many hours and miles you've driven on the home screen
   - Fleet Manager to easily access your driving data and screen recordings
   - Numerical temperature gauge
@@ -198,17 +201,12 @@ Credits
 * [DragonPilot](https://github.com/dragonpilot-community)
 * [ErichMoraga](https://github.com/ErichMoraga)
 * [Garrettpall](https://github.com/garrettpall)
-* [Henrycc](https://github.com/henryccy)
-* [KRKeegan](https://github.com/krkeegan)
 * [Mike8643](https://github.com/mike8643)
-* [Move-Fast](https://github.com/move-fast)
 * [Neokii](https://github.com/Neokii)
 * [OPGM](https://github.com/opgm)
 * [OPKR](https://github.com/openpilotkr)
 * [Pfeiferj](https://github.com/pfeiferj)
 * [ServerDummy](https://github.com/ServerDummy)
-* [Sunnyhaibin](https://github.com/sunnyhaibin)
-* [Thinkpad4by3](https://github.com/Thinkpad4by3)
 * [Twilsonco](https://github.com/twilsonco)
 
 Licensing