diff --git a/README.md b/README.md index f54857e0..da455720 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # DashPilot -![Dashpilot header](./assets/dashpilot-header.png) +![DashPilot dash apps running in a Tesla](./banner.jpg) Turn your phone into a real-time dashboard for your car. DashPilot connects to your car, and provides a real-time dashboard right on your phone. It serves as a speedometer, shows the ACC speed you set, speed limit, blinkers, blind spots, and many more. diff --git a/assets/dashpilot-header.png b/assets/dashpilot-header.png deleted file mode 100644 index ffd48ebe..00000000 Binary files a/assets/dashpilot-header.png and /dev/null differ diff --git a/banner.jpg b/banner.jpg new file mode 100644 index 00000000..5887a9ac Binary files /dev/null and b/banner.jpg differ diff --git a/dash-apps/README.md b/dash-apps/README.md index d9a600b3..654ae5e6 100644 --- a/dash-apps/README.md +++ b/dash-apps/README.md @@ -127,10 +127,11 @@ Web apps get one string of storage, usually JSON. ## Adding a web app to the apps -1. `dash-apps/web-/` with `index.html`, `preview.jpg` (landscape, ~2:1) and a `manifest.json`. `settings` lists the display settings your app uses, so the app only offers those: +1. `dash-apps/web-/` with `index.html`, `preview.jpg` (landscape, ~2:1) and a `manifest.json`: ```json - { "$schema": "../../docs/dashapp-manifest.schema.json", "manifestVersion": 1, "id": "", "settings": ["useImperial", "darkMode"] } + { "$schema": "../manifest.schema.json", "manifestVersion": 1, "id": "", "settings": ["useImperial", "darkMode"] } ``` + `id` is lowercase letters, digits and hyphens, matching the folder name. `settings` lists the display settings your app uses, so the app only offers those: `showPhoneBattery`, `showCarBattery`, `showOdometer`, `alwaysOnBlindSpotMonitor`, `useImperial`, `darkMode`, `renderQuality`, `darkModeBackgroundGray`. 2. Add `web-` to `DEFAULT_FOLDERS` in `scripts/sync-to-android.sh` and `scripts/sync-to-ios.sh`. 3. Android: an entry in `availableDashboards` (`datamodel/dash/DashboardConfig.kt`) and a `dashboard_name_` string. 4. iOS: an entry in `availableDashboards` (`Models/DashboardConfig.swift`), `` in `localApps` in `UI/WebDashView.swift`, and a `preview_.imageset` in `Assets.xcassets` (copy an existing one). diff --git a/docs/dashapp-manifest.schema.json b/dash-apps/manifest.schema.json similarity index 100% rename from docs/dashapp-manifest.schema.json rename to dash-apps/manifest.schema.json diff --git a/dash-apps/web-ambient/manifest.json b/dash-apps/web-ambient/manifest.json index 514b47ab..a128995d 100644 --- a/dash-apps/web-ambient/manifest.json +++ b/dash-apps/web-ambient/manifest.json @@ -1,5 +1,5 @@ { - "$schema": "../../docs/dashapp-manifest.schema.json", + "$schema": "../manifest.schema.json", "manifestVersion": 1, "id": "ambient", "settings": ["useImperial", "darkMode"] diff --git a/dash-apps/web-analog/manifest.json b/dash-apps/web-analog/manifest.json index 3325cadd..9e862283 100644 --- a/dash-apps/web-analog/manifest.json +++ b/dash-apps/web-analog/manifest.json @@ -1,5 +1,5 @@ { - "$schema": "../../docs/dashapp-manifest.schema.json", + "$schema": "../manifest.schema.json", "manifestVersion": 1, "id": "analog", "settings": ["useImperial", "darkMode"] diff --git a/dash-apps/web-compose/manifest.json b/dash-apps/web-compose/manifest.json index 1f459897..2244e215 100644 --- a/dash-apps/web-compose/manifest.json +++ b/dash-apps/web-compose/manifest.json @@ -1,5 +1,5 @@ { - "$schema": "../../docs/dashapp-manifest.schema.json", + "$schema": "../manifest.schema.json", "manifestVersion": 1, "id": "compose", "settings": ["useImperial", "darkMode"] diff --git a/dash-apps/web-retro/manifest.json b/dash-apps/web-retro/manifest.json index f5647e11..64c952f2 100644 --- a/dash-apps/web-retro/manifest.json +++ b/dash-apps/web-retro/manifest.json @@ -1,5 +1,5 @@ { - "$schema": "../../docs/dashapp-manifest.schema.json", + "$schema": "../manifest.schema.json", "manifestVersion": 1, "id": "retro", "settings": ["useImperial", "darkMode"] diff --git a/dash-apps/web-vanilla/manifest.json b/dash-apps/web-vanilla/manifest.json index 4c13ace9..1b7e5a53 100644 --- a/dash-apps/web-vanilla/manifest.json +++ b/dash-apps/web-vanilla/manifest.json @@ -1,5 +1,5 @@ { - "$schema": "../../docs/dashapp-manifest.schema.json", + "$schema": "../manifest.schema.json", "manifestVersion": 1, "id": "vanilla", "settings": [ diff --git a/scripts/validate-manifests.js b/scripts/validate-manifests.js index 4d741d5f..50aa7783 100644 --- a/scripts/validate-manifests.js +++ b/scripts/validate-manifests.js @@ -2,7 +2,7 @@ const fs = require("node:fs"); const path = require("node:path"); -const SCHEMA_PATH = path.join(__dirname, "..", "docs", "dashapp-manifest.schema.json"); +const SCHEMA_PATH = path.join(__dirname, "..", "dash-apps", "manifest.schema.json"); const APPS_DIR = path.join(__dirname, "..", "dash-apps"); const ROOT_KEYS = new Set(["$schema", "manifestVersion", "id", "settings"]);