diff --git a/.agents/skills/bug-fix/SKILL.md b/.agents/skills/bug-fix/SKILL.md index a649cff9..0f9d8af3 100644 --- a/.agents/skills/bug-fix/SKILL.md +++ b/.agents/skills/bug-fix/SKILL.md @@ -1,6 +1,6 @@ --- name: bug-fix -description: Fix a Device Studio bug the project's way - reproduce it, write a small failing test, find the root cause, fix it, prove the test now passes. Use for any bug report or broken feature; escalates to a spec when the cause or fix is not obvious. +description: Fix a Device bug the project's way - reproduce it, write a small failing test, find the root cause, fix it, prove the test now passes. Use for any bug report or broken feature; escalates to a spec when the cause or fix is not obvious. --- # Fix a bug diff --git a/.agents/skills/dstudio-bench/SKILL.md b/.agents/skills/dstudio-bench/SKILL.md index 9ed551fe..a0ef57d1 100644 --- a/.agents/skills/dstudio-bench/SKILL.md +++ b/.agents/skills/dstudio-bench/SKILL.md @@ -1,6 +1,6 @@ --- name: dstudio-bench -description: Measure Device Studio's performance before and after a change - which engine, core or app benchmark covers what, how to run a fair comparison, when to add a benchmark, and how to report the numbers in a pull request. Use for any change that could affect CPU, memory, latency, frame time or load time. +description: Measure Device's performance before and after a change - which engine, core or app benchmark covers what, how to run a fair comparison, when to add a benchmark, and how to report the numbers in a pull request. Use for any change that could affect CPU, memory, latency, frame time or load time. --- # Benchmarks diff --git a/.agents/skills/dstudio-builtin-device/SKILL.md b/.agents/skills/dstudio-builtin-device/SKILL.md index 463829dd..4537c7e3 100644 --- a/.agents/skills/dstudio-builtin-device/SKILL.md +++ b/.agents/skills/dstudio-builtin-device/SKILL.md @@ -1,6 +1,6 @@ --- name: dstudio-builtin-device -description: Add or rework one of Device Studio's built-in effects or instruments - the DeviceDef in dstudio-core, the BuiltinProcessor kernel in engine/src/devices, the card or custom view in the app, presets, tests, benchmark row and review state. Use for any work on a built-in device, its parameters, DSP or panel. +description: Add or rework one of Device's built-in effects or instruments - the DeviceDef in dstudio-core, the BuiltinProcessor kernel in engine/src/devices, the card or custom view in the app, presets, tests, benchmark row and review state. Use for any work on a built-in device, its parameters, DSP or panel. --- # Built-in devices diff --git a/.agents/skills/dstudio-command/SKILL.md b/.agents/skills/dstudio-command/SKILL.md index bf3556bc..fe44aaf0 100644 --- a/.agents/skills/dstudio-command/SKILL.md +++ b/.agents/skills/dstudio-command/SKILL.md @@ -1,6 +1,6 @@ --- name: dstudio-command -description: Add or change an edit in Device Studio's application core - a dstudio_core::Command with validation, exact inverse, coalescing, undo label and JSON form - plus the model, persistence, migration and snapshot changes it needs. Use whenever a change lets the user (or the assistant, or a script) modify a project. +description: Add or change an edit in Device's application core - a dstudio_core::Command with validation, exact inverse, coalescing, undo label and JSON form - plus the model, persistence, migration and snapshot changes it needs. Use whenever a change lets the user (or the assistant, or a script) modify a project. --- # Adding or changing an edit diff --git a/.agents/skills/dstudio-engine-abi/SKILL.md b/.agents/skills/dstudio-engine-abi/SKILL.md index 4bf280d6..7fedcd45 100644 --- a/.agents/skills/dstudio-engine-abi/SKILL.md +++ b/.agents/skills/dstudio-engine-abi/SKILL.md @@ -1,6 +1,6 @@ --- name: dstudio-engine-abi -description: Change the boundary between Device Studio's Rust code and its C++ engine (engine/include/dstudio_engine.h, crates/dstudio-engine) or anything that runs on the audio thread - real-time rules, how data crosses threads, layout tests, allocation guards. Use for any engine feature, new se_* function or struct, or audio-callback change. +description: Change the boundary between Device's Rust code and its C++ engine (engine/include/dstudio_engine.h, crates/dstudio-engine) or anything that runs on the audio thread - real-time rules, how data crosses threads, layout tests, allocation guards. Use for any engine feature, new se_* function or struct, or audio-callback change. --- # The C ABI and the audio thread diff --git a/.agents/skills/dstudio-pr/SKILL.md b/.agents/skills/dstudio-pr/SKILL.md index d7fae577..9d9ca0b0 100644 --- a/.agents/skills/dstudio-pr/SKILL.md +++ b/.agents/skills/dstudio-pr/SKILL.md @@ -1,6 +1,6 @@ --- name: dstudio-pr -description: Open a Device Studio pull request the project's way - one change per PR rebased on main, the local gate passing, the PR template filled with before/after screenshots and benchmark numbers, README and docs updated, then CI green and every review finding fixed. Use whenever asked to open, prepare or finish a pull request. +description: Open a Device pull request the project's way - one change per PR rebased on main, the local gate passing, the PR template filled with before/after screenshots and benchmark numbers, README and docs updated, then CI green and every review finding fixed. Use whenever asked to open, prepare or finish a pull request. --- # Pull requests diff --git a/.agents/skills/dstudio-ui/SKILL.md b/.agents/skills/dstudio-ui/SKILL.md index 43dae624..a916377c 100644 --- a/.agents/skills/dstudio-ui/SKILL.md +++ b/.agents/skills/dstudio-ui/SKILL.md @@ -1,6 +1,6 @@ --- name: dstudio-ui -description: Work on Device Studio's interface - Slint components in crates/dstudio-app/ui, the controller and panels in crates/dstudio-app/src, wgpu surfaces, design tokens, review states rendered with --state/--screenshot, and the app self-test. Use for any visible change or UI behaviour change. +description: Work on Device's interface - Slint components in crates/dstudio-app/ui, the controller and panels in crates/dstudio-app/src, wgpu surfaces, design tokens, review states rendered with --state/--screenshot, and the app self-test. Use for any visible change or UI behaviour change. --- # The app and its interface diff --git a/.agents/skills/spec-build/SKILL.md b/.agents/skills/spec-build/SKILL.md index 28d7aa97..e01369ef 100644 --- a/.agents/skills/spec-build/SKILL.md +++ b/.agents/skills/spec-build/SKILL.md @@ -1,6 +1,6 @@ --- name: spec-build -description: Implement an agreed Device Studio spec by working through its tasks.md in order, verifying and ticking each task. Use after spec-plan, when plan.md is agreed and the spec is Building. +description: Implement an agreed Device spec by working through its tasks.md in order, verifying and ticking each task. Use after spec-plan, when plan.md is agreed and the spec is Building. --- # Build a spec diff --git a/.agents/skills/spec-plan/SKILL.md b/.agents/skills/spec-plan/SKILL.md index 11accb09..865d590a 100644 --- a/.agents/skills/spec-plan/SKILL.md +++ b/.agents/skills/spec-plan/SKILL.md @@ -1,6 +1,6 @@ --- name: spec-plan -description: Turn an agreed Device Studio spec into plan.md (design layer by layer, principles check, tests and evidence, risks) and an ordered tasks.md. Use after spec-write, once spec.md is Agreed. +description: Turn an agreed Device spec into plan.md (design layer by layer, principles check, tests and evidence, risks) and an ordered tasks.md. Use after spec-write, once spec.md is Agreed. --- # Plan a spec diff --git a/.agents/skills/spec-verify/SKILL.md b/.agents/skills/spec-verify/SKILL.md index e94259d2..654cff40 100644 --- a/.agents/skills/spec-verify/SKILL.md +++ b/.agents/skills/spec-verify/SKILL.md @@ -1,6 +1,6 @@ --- name: spec-verify -description: Check a built Device Studio spec against the code before its pull request - every requirement and acceptance check, the principles, docs, tests, screenshots and benchmark evidence - and mark it Done. Use after spec-build, and again after any review changes. +description: Check a built Device spec against the code before its pull request - every requirement and acceptance check, the principles, docs, tests, screenshots and benchmark evidence - and mark it Done. Use after spec-build, and again after any review changes. --- # Verify a spec diff --git a/.agents/skills/spec-write/SKILL.md b/.agents/skills/spec-write/SKILL.md index d42e2648..c1b83658 100644 --- a/.agents/skills/spec-write/SKILL.md +++ b/.agents/skills/spec-write/SKILL.md @@ -1,6 +1,6 @@ --- name: spec-write -description: Start spec-driven work on Device Studio by writing specs/NNN-slug/spec.md (problem, behaviour, requirements, acceptance checks, out of scope, open questions). Use when someone asks for a new feature, a behaviour change, cross-layer or performance work, or a format or C ABI change, before any code is written. +description: Start spec-driven work on Device by writing specs/NNN-slug/spec.md (problem, behaviour, requirements, acceptance checks, out of scope, open questions). Use when someone asks for a new feature, a behaviour change, cross-layer or performance work, or a format or C ABI change, before any code is written. --- # Write a spec diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 8244416f..ee14de9c 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -2,11 +2,11 @@ name: Release # Builds the installable packages and, for a version tag, publishes them as a draft # GitHub release: -# macOS DeviceStudio--macos-universal.dmg (Apple silicon + Intel) -# Windows DeviceStudio--windows-x64-setup.exe (installer) -# DeviceStudio--windows-x64.zip (portable) -# Linux DeviceStudio--linux-x86_64.tar.gz -# DeviceStudio--linux-aarch64.tar.gz +# macOS Device--macos-universal.dmg (Apple silicon + Intel) +# Windows Device--windows-x64-setup.exe (installer) +# Device--windows-x64.zip (portable) +# Linux Device--linux-x86_64.tar.gz +# Device--linux-aarch64.tar.gz # # Releasing: set `version` in the root Cargo.toml to X.Y.Z, merge that to main, then push # the tag vX.Y.Z on that commit. The tag must be on main and match Cargo.toml, or nothing @@ -167,19 +167,19 @@ jobs: DSTUDIO_MACOS_X86_DIR: build/macos-x86_64 run: | bash tools/release/package-macos.sh build/macos - ditto -c -k --keepParent "build/macos/Device Studio.app" build/macos/DeviceStudio-app.zip + ditto -c -k --keepParent "build/macos/Device.app" build/macos/Device-app.zip # The unsigned app goes to the signing job (tags only); every other run makes an # ad hoc signed .dmg here, with no secrets in reach. - uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2 if: github.event_name == 'push' && github.ref_type == 'tag' with: name: macos-app - path: build/macos/DeviceStudio-app.zip + path: build/macos/Device-app.zip if-no-files-found: error retention-days: 1 - name: Package .dmg (ad hoc signed) if: env.IS_RELEASE != 'true' - run: bash tools/release/make-dmg.sh "build/macos/Device Studio.app" "${{ needs.version.outputs.version }}" dist + run: bash tools/release/make-dmg.sh "build/macos/Device.app" "${{ needs.version.outputs.version }}" dist - name: Smoke test (the packaged app starts and renders) if: env.IS_RELEASE != 'true' run: bash tools/release/smoke-macos.sh dist/*.dmg @@ -212,7 +212,7 @@ jobs: name: macos-app path: build/macos - name: Unpack the app - run: ditto -x -k build/macos/DeviceStudio-app.zip build/macos + run: ditto -x -k build/macos/Device-app.zip build/macos - name: Import the signing certificate and the notary key id: cert if: env.HAS_SIGNING_CERTIFICATE == 'true' @@ -246,7 +246,7 @@ jobs: # A tagged release must be signed and notarised. Set the repository variable # ALLOW_UNSIGNED_MACOS to true to publish an ad hoc signed .dmg instead. REQUIRE_SIGNING: ${{ vars.ALLOW_UNSIGNED_MACOS != 'true' && '1' || '' }} - run: bash tools/release/make-dmg.sh "build/macos/Device Studio.app" "${{ needs.version.outputs.version }}" dist + run: bash tools/release/make-dmg.sh "build/macos/Device.app" "${{ needs.version.outputs.version }}" dist - name: Remove the signing keychain and key if: always() run: | @@ -306,7 +306,7 @@ jobs: SLINT_WGPU_CPU: '1' # WARP: no GPU on the runner run: | $setup = Get-ChildItem dist -Filter '*-setup.exe' | Select-Object -First 1 - $dir = Join-Path $env:RUNNER_TEMP 'DeviceStudio' + $dir = Join-Path $env:RUNNER_TEMP 'Device' $p = Start-Process -FilePath $setup.FullName -ArgumentList '/VERYSILENT', '/SUPPRESSMSGBOXES', '/CURRENTUSER', "/DIR=$dir" -Wait -PassThru if ($p.ExitCode -ne 0) { throw "installer exit code $($p.ExitCode)" } foreach ($f in 'device-studio.exe', 'dstudio_plugin_scanner.exe', 'vcruntime140.dll') { @@ -421,6 +421,6 @@ jobs: gh release create "$GITHUB_REF_NAME" dist/* \ --repo "$GITHUB_REPOSITORY" \ --draft \ - --title "Device Studio ${{ needs.version.outputs.version }}" \ + --title "Device ${{ needs.version.outputs.version }}" \ --generate-notes \ --verify-tag diff --git a/PROGRESS.md b/PROGRESS.md index 8b281e64..c02cfb1e 100644 --- a/PROGRESS.md +++ b/PROGRESS.md @@ -483,3 +483,13 @@ see `.github/workflows/ci.yml`). Platform status: `engine/README.md` › Platfor - Tests: `scanner_searches_custom_folders` (a copy of the test gain CLAP in a temp folder is found, a missing folder is skipped, and the plugin goes when the folder does), `custom_plugin_folders_are_added_once_and_never_shadow_a_standard_one`, the preferences round trip, and self-test section `plugin_folder_steps`. Review state `review-plugin-folders`. + +### 2026-11-12: Device public name + +- Public organization/profile, website, current docs, README hero and sharing artwork use **Device**. +- Desktop windows, menus, update text, export creator and audio/MIDI/plugin host display names use Device. +- macOS bundles are `Device.app`; release titles, download archives, Windows installer/shortcuts and + Linux launcher labels use Device. Windows upgrades remove legacy default shortcuts. +- Existing `.dsproj` format, preferences/cache/project/scratch paths, executable, crate names, + platform identities and installer AppId remain stable; see `docs/building.md` › Compatibility names. +- Historical entries retain the name used at the time. See spec 004 for requirements and verification. diff --git a/crates/dstudio-app/Cargo.toml b/crates/dstudio-app/Cargo.toml index 10cb0c1c..6d7fced0 100644 --- a/crates/dstudio-app/Cargo.toml +++ b/crates/dstudio-app/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "dstudio-app" -description = "Device Studio desktop application (Slint shell + custom wgpu timeline)" +description = "Device desktop application (Slint shell + custom wgpu timeline)" edition.workspace = true version.workspace = true license.workspace = true diff --git a/crates/dstudio-app/src/appmenu.rs b/crates/dstudio-app/src/appmenu.rs index 1efff160..e65cf49e 100644 --- a/crates/dstudio-app/src/appmenu.rs +++ b/crates/dstudio-app/src/appmenu.rs @@ -1,13 +1,13 @@ //! macOS app menu. Slint's winit backend builds the app menu itself (About, Services, Hide, //! Quit) and builds it again whenever the menu bar changes, with no way to add items to it. -//! The first menu of our MenuBar ("Device Studio") holds the items that belong there +//! The first menu of our MenuBar ("Device") holds the items that belong there //! (Settings…). After each rebuild, a copy of each goes into the app menu below About, //! followed by a separator, and the holder is hidden. A //! copy targets the original item, so choosing it runs the original's Slint callback; the //! originals stay in the holder because the next rebuild removes them from there. #[cfg(target_os = "macos")] -const HOLDER: &str = "Device Studio"; +const HOLDER: &str = "Device"; /// Polls cheaply: nothing happens unless the menu bar was rebuilt since the last call. #[cfg(target_os = "macos")] diff --git a/crates/dstudio-app/src/assistant_provider.rs b/crates/dstudio-app/src/assistant_provider.rs index afb32de3..7690d8cd 100644 --- a/crates/dstudio-app/src/assistant_provider.rs +++ b/crates/dstudio-app/src/assistant_provider.rs @@ -130,7 +130,7 @@ pub fn system_prompt(mode: Mode) -> String { } }; format!( - "You are the assistant inside Device Studio, a desktop digital audio workstation (DAW). The window has a header with a \ + "You are the assistant inside Device, a desktop digital audio workstation (DAW). The window has a header with a \ transport bar (play, loop, bar/time readouts, BPM, key, time signature, metronome, master volume), a sound browser on the \ left, a timeline with track headers (mute, solo, arm, pan knob, volume slider) and lanes holding audio clips, a master row, \ and a bottom panel with the track inspector and devices, which can switch to a mixer. Time positions are in ticks (960 per \ diff --git a/crates/dstudio-app/src/dialogs.rs b/crates/dstudio-app/src/dialogs.rs index 50ed6f47..8d573f26 100644 --- a/crates/dstudio-app/src/dialogs.rs +++ b/crates/dstudio-app/src/dialogs.rs @@ -590,7 +590,7 @@ impl Controller { let bytes = live_set::gzip(&xml).map_err(|e| e.to_string())?; std::fs::create_dir_all(&folder).map_err(|e| e.to_string())?; std::fs::write(&als, bytes).map_err(|e| e.to_string())?; - let _ = writeln!(notes, "Exported from Device Studio for Ableton Live 11 or later.\n"); + let _ = writeln!(notes, "Exported from Device for Ableton Live 11 or later.\n"); if rendered.is_empty() { let _ = writeln!(notes, "No track has clips, so the set has empty tracks only."); } else { diff --git a/crates/dstudio-app/src/live_set.rs b/crates/dstudio-app/src/live_set.rs index b9257217..2c81fe61 100644 --- a/crates/dstudio-app/src/live_set.rs +++ b/crates/dstudio-app/src/live_set.rs @@ -722,7 +722,7 @@ pub fn to_xml(set: &LiveSet) -> String { ("MajorVersion", MAJOR_VERSION.into()), ("MinorVersion", MINOR_VERSION.into()), ("SchemaChangeCount", "3".into()), - ("Creator", "Device Studio".into()), + ("Creator", "Device".into()), ("Revision", String::new()), ], ); diff --git a/crates/dstudio-app/src/main.rs b/crates/dstudio-app/src/main.rs index 87b8a85a..2a11e684 100644 --- a/crates/dstudio-app/src/main.rs +++ b/crates/dstudio-app/src/main.rs @@ -1,4 +1,4 @@ -//! Device Studio desktop application (milestone 1). +//! Device desktop application (milestone 1). //! //! Slint shell (FemtoVG on wgpu 30) + our own wgpu timeline renderer //! (`gpu/`), wired to the real `dstudio_core::Document` and the C++ engine. diff --git a/crates/dstudio-app/ui/app.slint b/crates/dstudio-app/ui/app.slint index 30aa5a44..97775efa 100644 --- a/crates/dstudio-app/ui/app.slint +++ b/crates/dstudio-app/ui/app.slint @@ -1,4 +1,4 @@ -// Device Studio main window. +// Device main window. // // Geometry is in window-relative points at 1440x820. // Panels are positioned absolutely; right-hand @@ -1046,7 +1046,7 @@ export struct LayoutAnchors { } export component AppWindow inherits Window { - title: Studio.project-name + " — Device Studio"; + title: Studio.project-name + " — Device"; preferred-width: 1440px; preferred-height: 820px; min-width: 960px; @@ -1061,7 +1061,7 @@ export component AppWindow inherits Window { // menu after About and hides this menu (other platforms show it as is). MenuBar { Menu { - title: "Device Studio"; + title: "Device"; MenuItem { title: "Settings…"; enabled: !Studio.menu-replay; shortcut: @keys(Control + ","); activated => { Studio.menu-key(",", true, false); } } MenuSeparator { } } diff --git a/crates/dstudio-app/ui/dialogs.slint b/crates/dstudio-app/ui/dialogs.slint index 9ce055f8..59015494 100644 --- a/crates/dstudio-app/ui/dialogs.slint +++ b/crates/dstudio-app/ui/dialogs.slint @@ -210,7 +210,7 @@ export component UpdatesModal inherits Rectangle { } Text { x: 17px; y: 40.8px; width: root.width - 34px; height: 30.6px; wrap: word-wrap; - text: "You're running Device Studio v\{Studio.app-version}. There's no update server yet, so new versions arrive as new builds."; + text: "You're running Device v\{Studio.app-version}. There's no update server yet, so new versions arrive as new builds."; color: #c8c9cc; font-size: 10.2px; font-weight: 500; letter-spacing: -0.2px; vertical-alignment: top; } PillButton { x: root.width - 17px - 40.8px; y: root.height - 17px - 27.2px; width: 40.8px; height: 27.2px; text: "OK"; primary: true; clicked => { Studio.updates-close(); } } diff --git a/crates/dstudio-app/ui/widgets.slint b/crates/dstudio-app/ui/widgets.slint index f0b821a5..91737c3b 100644 --- a/crates/dstudio-app/ui/widgets.slint +++ b/crates/dstudio-app/ui/widgets.slint @@ -1,4 +1,4 @@ -// Reusable widgets for the Device Studio shell. +// Reusable widgets for the Device shell. // All icons are simple vector drawings (16x16 viewbox). import { Tokens } from "tokens.slint"; diff --git a/crates/dstudio-core/Cargo.toml b/crates/dstudio-core/Cargo.toml index eea866fc..a667a7ab 100644 --- a/crates/dstudio-core/Cargo.toml +++ b/crates/dstudio-core/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "dstudio-core" -description = "Device Studio application core: project model, edit commands, undo/redo, persistence" +description = "Device application core: project model, edit commands, undo/redo, persistence" edition.workspace = true version.workspace = true license.workspace = true diff --git a/crates/dstudio-core/src/builtin/mod.rs b/crates/dstudio-core/src/builtin/mod.rs index 67712043..ce5d27a3 100644 --- a/crates/dstudio-core/src/builtin/mod.rs +++ b/crates/dstudio-core/src/builtin/mod.rs @@ -1166,7 +1166,7 @@ pub struct DeviceDef { pub const SIDECHAIN_ENABLE_IDS: [&str; 3] = ["sidechainEnable", "sidechain", "sc_source"]; /// The vendor shown for built-in devices. -pub const VENDOR: &str = "Device Studio"; +pub const VENDOR: &str = "Device"; /// Every built-in device, in browser order. pub fn all() -> &'static [&'static DeviceDef] { diff --git a/crates/dstudio-core/src/lib.rs b/crates/dstudio-core/src/lib.rs index 29cb1683..c90fd34b 100644 --- a/crates/dstudio-core/src/lib.rs +++ b/crates/dstudio-core/src/lib.rs @@ -1,4 +1,4 @@ -//! Device Studio application core. +//! Device application core. //! //! * [`model`]: the authoritative project data model (application thread only) //! * [`command`]: validated, invertible, serialisable edit commands diff --git a/crates/dstudio-core/src/persist.rs b/crates/dstudio-core/src/persist.rs index 2e3b82f8..708ad1c3 100644 --- a/crates/dstudio-core/src/persist.rs +++ b/crates/dstudio-core/src/persist.rs @@ -27,7 +27,7 @@ pub enum PersistError { #[error("malformed project file: {0}")] Format(#[from] serde_json::Error), #[error( - "not a Device Studio project (format = {0:?}); a project saved before the app was renamed has to be opened in an earlier build and saved again with Save As under a .dsproj name" + "not a Device project (format = {0:?}); a project saved before the app was renamed has to be opened in an earlier build and saved again with Save As under a .dsproj name" )] WrongFormat(String), #[error("project schema {found} is newer than supported {supported}")] diff --git a/crates/dstudio-engine/Cargo.toml b/crates/dstudio-engine/Cargo.toml index 662cbff8..8ee5812f 100644 --- a/crates/dstudio-engine/Cargo.toml +++ b/crates/dstudio-engine/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "dstudio-engine" -description = "Safe Rust bindings to the Device Studio C++23 real-time audio engine (engine/include/dstudio_engine.h)" +description = "Safe Rust bindings to the Device C++23 real-time audio engine (engine/include/dstudio_engine.h)" edition.workspace = true version.workspace = true license.workspace = true diff --git a/docs/building.md b/docs/building.md index 001a16ab..11c17d5d 100644 --- a/docs/building.md +++ b/docs/building.md @@ -309,9 +309,9 @@ installable packages: | System | Package | |---|---| -| macOS 13+ | `DeviceStudio--macos-universal.dmg` (Apple silicon + Intel) | -| Windows x64 | `DeviceStudio--windows-x64-setup.exe` (installer) and a portable `.zip` | -| Linux x86_64, aarch64 | `DeviceStudio--linux-.tar.gz` (run `install.sh`) | +| macOS 13+ | `Device--macos-universal.dmg` (Apple silicon + Intel) | +| Windows x64 | `Device--windows-x64-setup.exe` (installer) and a portable `.zip` | +| Linux x86_64, aarch64 | `Device--linux-.tar.gz` (run `install.sh`) | The macOS app's two architectures build side by side on separate runners and are joined with `lipo` in a third job. Each package carries the plugin scanner next to the app, where the app looks @@ -338,3 +338,15 @@ Every other build is signed ad hoc, and macOS asks the user to allow it on first launch. The Windows packages are not signed yet, so SmartScreen warns on first run. The packaging scripts are in [`tools/release/`](../tools/release/). + +### Compatibility names + +The public app name is **Device**. The command-line executable remains `device-studio` and +internal crates, namespaces and options keep the `dstudio` prefix. Existing `.dsproj` files keep +the `device-studio-project` format identifier and schema. + +Preferences and plugin caches keep their existing locations (`Device Studio` on macOS/Windows, +`device-studio` on Linux), as does the default `~/Documents/Device Studio` project folder. Temporary +recording/render folders and configured project locations are unchanged. This preserves existing +settings, media references, scripts and OS permission associations while the visible app name changes. +The macOS bundle identifier and Windows installer AppId also remain stable. diff --git a/engine/src/platform/alsa_midi_input.cpp b/engine/src/platform/alsa_midi_input.cpp index 0d884af8..cafebbcd 100644 --- a/engine/src/platform/alsa_midi_input.cpp +++ b/engine/src/platform/alsa_midi_input.cpp @@ -5,7 +5,7 @@ // JACK bridge into it), it parses the byte stream into events, and several // applications can read the same port at once. // -// One sequencer client ("Device Studio") with one input port. Opening a +// One sequencer client ("Device") with one input port. Opening a // source subscribes that port to the source; closing unsubscribes. One // reader thread waits on the sequencer's poll descriptors plus a wake pipe // and turns events into channel messages for the source's receiver, so the @@ -105,7 +105,7 @@ class AlsaMidi final : public MidiBackend { return; } if (a_->snd_seq_open(&query_, "default", SND_SEQ_OPEN_OUTPUT, 0) < 0) query_ = nullptr; - a_->snd_seq_set_client_name(seq_, "Device Studio"); + a_->snd_seq_set_client_name(seq_, "Device"); port_ = a_->snd_seq_create_simple_port(seq_, "MIDI in", SND_SEQ_PORT_CAP_WRITE | SND_SEQ_PORT_CAP_SUBS_WRITE, SND_SEQ_PORT_TYPE_MIDI_GENERIC | SND_SEQ_PORT_TYPE_APPLICATION); if (query_ == nullptr || port_ < 0 || pipe(wake_) != 0) { @@ -114,7 +114,7 @@ class AlsaMidi final : public MidiBackend { seq_ = query_ = nullptr; return; } - a_->snd_seq_set_client_name(query_, "Device Studio (ports)"); + a_->snd_seq_set_client_name(query_, "Device (ports)"); self_ = a_->snd_seq_client_id(seq_); query_self_ = a_->snd_seq_client_id(query_); thread_ = std::thread([this] { run(); }); diff --git a/engine/src/platform/coreaudio_device.cpp b/engine/src/platform/coreaudio_device.cpp index a12c2f5f..ffb2a4e1 100644 --- a/engine/src/platform/coreaudio_device.cpp +++ b/engine/src/platform/coreaudio_device.cpp @@ -517,7 +517,7 @@ class CoreAudioDevice final : public AudioDevice { CFMutableDictionaryRef desc = new_dict(); dict_set_str(desc, CFSTR(kAudioAggregateDeviceUIDKey), uid); - dict_set_str(desc, CFSTR(kAudioAggregateDeviceNameKey), "Device Studio Duplex"); + dict_set_str(desc, CFSTR(kAudioAggregateDeviceNameKey), "Device Duplex"); dict_set_int(desc, CFSTR(kAudioAggregateDeviceIsPrivateKey), 1); dict_set_int(desc, CFSTR(kAudioAggregateDeviceIsStackedKey), 0); CFMutableArrayRef subs = CFArrayCreateMutable(nullptr, 0, &kCFTypeArrayCallBacks); diff --git a/engine/src/platform/coremidi_input.cpp b/engine/src/platform/coremidi_input.cpp index 9cb49736..a23f4df2 100644 --- a/engine/src/platform/coremidi_input.cpp +++ b/engine/src/platform/coremidi_input.cpp @@ -43,7 +43,7 @@ struct Connection { class CoreMidi final : public MidiBackend { public: CoreMidi() { - if (MIDIClientCreate(CFSTR("Device Studio"), nullptr, nullptr, &client_) != noErr) { + if (MIDIClientCreate(CFSTR("Device"), nullptr, nullptr, &client_) != noErr) { client_ = 0; return; } diff --git a/engine/src/platform/pipewire_device.cpp b/engine/src/platform/pipewire_device.cpp index 2c2dfadb..250e825c 100644 --- a/engine/src/platform/pipewire_device.cpp +++ b/engine/src/platform/pipewire_device.cpp @@ -596,7 +596,7 @@ class PipeWireDevice final : public AudioDevice { std::to_string(requested_quantum()) + "/" + std::to_string(static_cast(config_.sample_rate)); pw_properties* props = pw_properties_new(PW_KEY_MEDIA_TYPE, "Audio", PW_KEY_MEDIA_CATEGORY, playback ? "Playback" : "Capture", PW_KEY_MEDIA_ROLE, "Production", - PW_KEY_APP_NAME, "Device Studio", PW_KEY_NODE_LATENCY, latency.c_str(), + PW_KEY_APP_NAME, "Device", PW_KEY_NODE_LATENCY, latency.c_str(), nullptr); if (!target.empty()) pw_properties_set(props, PW_KEY_TARGET_OBJECT, target.c_str()); // One group for both streams: PipeWire runs them from the same driver @@ -606,7 +606,7 @@ class PipeWireDevice final : public AudioDevice { if (config_.device_rate > 0.0) pw_properties_set(props, PW_KEY_NODE_RATE, ("1/" + std::to_string(static_cast(std::lround(config_.device_rate)))).c_str()); - s.stream = pw_stream_new(core_, playback ? "Device Studio output" : "Device Studio input", props); + s.stream = pw_stream_new(core_, playback ? "Device output" : "Device input", props); if (s.stream == nullptr) { err = std::string("pw_stream_new failed: ") + std::strerror(errno); return s; diff --git a/engine/src/plugins/clap_instance.cpp b/engine/src/plugins/clap_instance.cpp index a07f683d..59695809 100644 --- a/engine/src/plugins/clap_instance.cpp +++ b/engine/src/plugins/clap_instance.cpp @@ -58,8 +58,8 @@ class ClapInstance final : public PluginInstance, public std::enable_shared_from event_store_(kMaxEvents + kMaxParamEvents + PluginInstance::kMaxParamEvents) { host_.clap_version = CLAP_VERSION; host_.host_data = this; - host_.name = "Device Studio"; - host_.vendor = "Device Studio"; + host_.name = "Device"; + host_.vendor = "Device"; host_.url = ""; host_.version = "0.1.0"; host_.get_extension = &ClapInstance::host_get_extension; diff --git a/engine/src/plugins/plugin_scan.cpp b/engine/src/plugins/plugin_scan.cpp index b6fb6110..b8b0fa18 100644 --- a/engine/src/plugins/plugin_scan.cpp +++ b/engine/src/plugins/plugin_scan.cpp @@ -211,8 +211,8 @@ bool scan_clap_bundle(const std::string& path, std::vector& out, } clap_host_t host{}; host.clap_version = CLAP_VERSION; - host.name = "Device Studio scanner"; - host.vendor = "Device Studio"; + host.name = "Device scanner"; + host.vendor = "Device"; host.url = ""; host.version = "0.1.0"; host.get_extension = [](const clap_host*, const char*) -> const void* { return nullptr; }; diff --git a/engine/test_plugins/dstudio_test_clap.cpp b/engine/test_plugins/dstudio_test_clap.cpp index 0cb9e866..dd6504ce 100644 --- a/engine/test_plugins/dstudio_test_clap.cpp +++ b/engine/test_plugins/dstudio_test_clap.cpp @@ -45,7 +45,7 @@ constexpr bool kInstrument = true; #endif const clap_plugin_descriptor_t kDescriptor = { - CLAP_VERSION_INIT, kId, kName, "DStudio", "", "", "", "1.0.0", "Device Studio test plugin", kFeatures}; + CLAP_VERSION_INIT, kId, kName, "DStudio", "", "", "", "1.0.0", "Device test plugin", kFeatures}; struct Voice { bool on = false; diff --git a/specs/003-midi-input-and-recording/spec.md b/specs/003-midi-input-and-recording/spec.md index d08b82e6..0f12f05c 100644 --- a/specs/003-midi-input-and-recording/spec.md +++ b/specs/003-midi-input-and-recording/spec.md @@ -4,7 +4,7 @@ Status: Building · Spec: 003 · Issue: none ## Problem -Device Studio plays instrument tracks only from notes drawn in the piano roll or imported from MIDI +Device plays instrument tracks only from notes drawn in the piano roll or imported from MIDI files. Nobody can play a MIDI keyboard into it, hear an instrument while playing, or record a performance. On instrument tracks the R (arm) and I (monitor) buttons only say "MIDI recording is not implemented yet". The engine has no MIDI input at all, on any platform. diff --git a/specs/004-device-public-name/plan.md b/specs/004-device-public-name/plan.md new file mode 100644 index 00000000..fd5bb5cd --- /dev/null +++ b/specs/004-device-public-name/plan.md @@ -0,0 +1,50 @@ +# Device name implementation plan + +The maintainer approved the spec's compatibility choices and explicitly authorized completing all +remaining phases without further design checkpoints. + +## Design + +- Core: change descriptive labels, package descriptions, built-in vendor and invalid-format error + text. Keep FORMAT, schema, device ids and parameters unchanged; no commands, snapshot or ABI changes. +- Engine: replace human-readable CLAP, Core Audio, Core MIDI, ALSA and PipeWire names and the test + plugin description. Keep platform window classes, aggregate uid prefix and PipeWire node-group key. + Follow the existing display-string sites; nothing changes on the real-time callback. +- App: replace Slint titles/update copy, native menu HOLDER, assistant context and exported creator + labels. Keep binary name, prefs/plugin-cache paths, default project dir and temporary media paths. +- Packages: produce Device.app and Device- archives, keep macOS bundle id and Windows AppId, + executable and Linux desktop-file identity. Inno Setup uses Device as the new default directory and + group, reuses an existing install directory through its stable AppId, and removes legacy Device Studio + shortcut files on upgrade. Update workflow paths/titles and smoke scripts together. +- Docs: current branding uses Device; add a compatibility note to building docs and a current progress + entry. Completed specs, ADRs and historical progress entries keep their original wording. +- Public org/site/docs artwork were updated in separate cosmetic commits before app implementation. + Keep that result and the contribution/security policies intact. + +## Principles check + +1. Real-time safety: only fixed display literals change, no new callback work. +2. One mutation path: no project edits or commands are added. +3. Projects keep loading: format, schema and device ids/parameters unchanged. +4. C ABI: no declarations or layout changes. +5. Cross-platform: all display/package names and corresponding workflow references updated together. +6. Original work: reuse project-owned artwork. +7. Evidence: screenshots, package fixture checks and existing full test gate; no performance benchmark + needed because naming literals do not alter algorithms, drawing, allocation, DSP or threading. +8. Docs: current docs and PROGRESS updated with code. +9. Naming: dstudio internal names and device-studio executable remain stable. +10. Rules: preserve all principles; approval covered compatibility and remaining workflow. + +## Verification + +Run formatting, clippy and workspace tests; configure/build/test the C++ engine; build the release +app and run its self-test. Capture before/after review states and native app title evidence when +available. Exercise macOS bundling with fixture executables and plist checks, syntax-check shell scripts, +and inspect all workflow package paths. Windows/Linux native installer execution is delegated to +existing CI and must be reported accurately. + +## Alternatives + +A full identifier/path rename was rejected because it would disrupt projects, scripts, settings, +OS grants and upgrade identity. Migration logic is unnecessary for a display-name change. + diff --git a/specs/004-device-public-name/spec.md b/specs/004-device-public-name/spec.md new file mode 100644 index 00000000..73edecb2 --- /dev/null +++ b/specs/004-device-public-name/spec.md @@ -0,0 +1,70 @@ +# Device public name + +Status: Done · Spec: 004 · Issue: none + +## Problem + +The project is presented as Device Studio across GitHub, the website, desktop interface and release packages. +The maintainer has chosen the shorter public name Device. Mixed names make the product harder to recognize. + +## Behaviour + +The organization, profile, website, current repository documentation, artwork, desktop windows, +menus, update messages, plugin host labels and installer labels present the product as Device. +The waveform logo and "Built for real time." tagline stay the same. + +macOS packages contain Device.app. Release downloads use Device- names and release titles +say Device. Windows installation and shortcuts use Device; the fixed installer identity remains +the same so upgrades continue to target the existing installation. The Linux launcher displays Device. + +Existing projects, preferences, plugin caches and configured project folders continue to work. +This naming change adds no project edits or undo entries. The project schema and identifiers do not change. + +## Requirements + +- R1. Public GitHub organization name, profile text, website content, metadata, and current repo + documentation and artwork must use Device. +- R2. Desktop title, menus, About/update copy, assistant context, exported creator labels, built-in + device vendor and OS audio/MIDI/plugin host display names must use Device. +- R3. macOS bundle display name and bundle path, Windows installer/shortcut display names, Linux + launcher name, release titles and downloadable archive names must use Device consistently. +- R4. Existing .dsproj projects and built-in device identifiers/parameters must remain readable + without a schema migration. Keep the device-studio-project format identifier. +- R5. Keep existing preference/cache locations, default project folder, recording/render scratch + locations, macOS bundle identity and Windows installer AppId so current user data and permissions + remain associated with this app. Explain retained legacy paths in the documentation. +- R6. Keep dstudio crates/namespaces/options, the device-studio executable, desktop-file identity + and private window classes stable. GitHub addresses and repository names stay unchanged. +- R7. Packaging workflows and smoke checks must agree with renamed bundle/archive paths. Windows + upgrades should remove old Device Studio shortcut labels while retaining the existing installation. +- R8. Preserve the original brand in historical progress entries and completed historical specs/ADRs. + Current documentation should use Device and distinguish compatibility names where necessary. +- R9. Contribution restrictions, security settings, licensing and public feature claims must remain intact. + +## Acceptance checks + +- A1 (R1, R8, R9): Inspect current docs/profile/site text and regenerated hero/social artwork. Check + the live org and deployed website, including title, logo alt text, links and contribution policy. + Search remaining old-brand occurrences and classify each as historical or a compatibility identifier. +- A2 (R2): Build the app and render an existing review state; verify Device in the title/menu. + Inspect exported creator and host display strings. Run the existing app self-test. +- A3 (R3, R5, R7): Exercise macOS bundle creation with controlled fixture executables; verify + Device.app, plist display names, stable identity and bundled scanner. Check release script syntax + and workflow/package references. Verify Linux package launcher naming and stable executable paths. + Report Windows/Linux execution limits if those platforms are unavailable. +- A4 (R4, R5, R6): Run existing persistence/preferences tests and inspect the unchanged compatibility + identifiers and paths. No bulk rename of stored format, crate, namespace, environment option or executable. +- A5 (R2, R4, R7): Run the repository's required build/test checks appropriate to touched code and + report any pre-existing or platform-specific failures separately. + +## Out of scope + +- Renaming devicedaw, device, devicedaw.github.io or changing their URLs. +- Renaming internal dstudio identifiers or the device-studio executable. +- Moving user files, changing project format, adding migration logic or changing permissions. +- Publishing a release, paying for services, changing the logo design or rewriting historical records. + +## Open questions + +None. The maintainer approved the compatibility approach and authorized all remaining phases. + diff --git a/specs/004-device-public-name/tasks.md b/specs/004-device-public-name/tasks.md new file mode 100644 index 00000000..29cd4e64 --- /dev/null +++ b/specs/004-device-public-name/tasks.md @@ -0,0 +1,10 @@ +# Device name tasks + +- [x] Inventory old branding and agree compatibility requirements. +- [x] Update organization, profile, website, current documentation and public banner artwork. +- [x] Update app/core/engine display labels, preserving stable identifiers and paths. +- [x] Update installers, bundle/archive names, workflow references and legacy Windows shortcuts. +- [x] Update current docs, skills descriptions and progress; classify remaining old-name occurrences. +- [x] Run formatting, lint, tests, package fixtures and capture before/after evidence. +- [x] Review against spec, record verification and prepare the app rename pull request (CI tracked on the PR). + diff --git a/specs/004-device-public-name/verification.md b/specs/004-device-public-name/verification.md new file mode 100644 index 00000000..feaccd9c --- /dev/null +++ b/specs/004-device-public-name/verification.md @@ -0,0 +1,63 @@ +# Device name verification + +## Local results (Apple M4, macOS) + +- Formatting and diff whitespace checks passed. +- `cargo clippy --workspace` passed with existing warnings; no warning-bearing logic changed. +- `cargo test --workspace`: 552 passed, 0 failed, 10 ignored (existing hardware/platform exclusions). +- CMake default configure/build and CTest: 510 passed, 3 skipped, 0 failed out of 513 registered checks. + Skips: hardware duplex loopback and Win32/X11 editor checks unavailable on this machine. +- Release app built successfully; `--self-test --no-audio`: **636 / 636 checks passed**. +- All 11 repository skill files passed their consistency check. +- Shell syntax checks passed for bundle/release scripts. +- A fixture macOS bundle verified `Device.app`, Device plist display names, scanner inclusion, + the unchanged `com.dstudio.studio` identity and the unchanged `device-studio` executable. +- Linux package staging/install layout passed a fixture check, including archive and desktop name. + The test used a strip stub for fixture shell scripts on macOS; it does not claim native ELF + execution or a Linux runtime test. +- A direct comparison with the base commit proved preferences/cache/project/scratch code paths, + persistence format/schema, macOS bundle identifier and Windows AppId unchanged. +- Native Windows installer execution and Linux runtime checks are provided by the existing Release + pull-request workflow. A native legacy Windows upgrade was not run locally. + +## Requirements + +- R1: public org display name and profile verified live; website deployment succeeded and was checked + in Chrome. Cosmetic repo commit 2bedea2, profile commit e029dea and website commit eb7fc19 use Device. + Both the README hero and social-preview artwork were rendered from the project's HTML and visually + inspected. The repository's configured social preview was uploaded and verified in GitHub. +- R2: fixed display literals in Slint, native menu holder, export metadata, assistant context, + built-in vendor and platform/plugin host descriptions use Device. The full app self-test passed. +- R3, R7: macOS bundle and Linux staging fixtures passed; all release workflow paths match their + producer scripts. Windows keeps AppId, reuses previous application directories and explicitly changes + the Start Menu group; only legacy default shortcut files and their empty folder are removed. +- R4–R6: stable format/schema, ids, parameters, preference/media/project locations, executable, + crate names, namespace/options, private window classes and installation identities are retained. +- R8: current prose and skill descriptions use Device. Historical progress entries, completed + historical specs and ADRs retain their original wording. +- R9: contribution text changed only the product name. No security settings, licensing, permissions + or feature capabilities were changed. + +## Visual evidence + +Both app images use `reference-default`, `--no-audio --offscreen`, the same default zoom and a +2880×1640 output. The before image was built from base commit 2bedea2; the after image was built +from this branch. The macOS native app menu/window title are outside the app's screenshot capture, +so these images confirm the workstation body remains stable; title/menu changes are verified in +the Slint/native-menu diff and bundle plist checks. + +Media commit: 02610c633ffce8128df7a0f5b852058df5dc0cad on the append-only pr-screenshots branch. + +## Principles + +No DSP, audio callback, threading, rendering algorithm, command, project data or ABI layout changes. +No performance benchmark is required for display-literal and installer-label changes. No new +third-party artwork or dependencies. Internal naming and project compatibility principles are retained. + +## Installer reference + +Inno Setup preserves an existing directory through its unchanged AppId and default +[UsePreviousAppDir](https://jrsoftware.org/ishelp/topic_setup_usepreviousappdir.htm). +[UsePreviousGroup](https://jrsoftware.org/ishelp/topic_setup_usepreviousgroup.htm) is explicitly +disabled so the public Start Menu folder gets the new Device name. + diff --git a/specs/principles.md b/specs/principles.md index 058079bc..4c8c2b5a 100644 --- a/specs/principles.md +++ b/specs/principles.md @@ -1,6 +1,6 @@ # Principles -The rules every change to Device Studio follows, from people and agents alike. Each one points at +The rules every change to Device follows, from people and agents alike. Each one points at the document that owns it, so this file stays short and the owning document stays the authority. A spec's plan checks itself against this list (`plan.md` › Principles check). diff --git a/tools/macos-bundle.sh b/tools/macos-bundle.sh index c1a78a59..100bfd8f 100755 --- a/tools/macos-bundle.sh +++ b/tools/macos-bundle.sh @@ -1,6 +1,6 @@ #!/usr/bin/env bash -# Wraps the release build in "Device Studio.app", so macOS names the app menu, About, Hide and -# Quit "Device Studio" instead of the executable's name. +# Wraps the release build in "Device.app", so macOS names the app menu, About, Hide and +# Quit "Device" instead of the executable's name. # Usage: tools/macos-bundle.sh [output dir] (default: $CARGO_TARGET_DIR/release or target/release) # DSTUDIO_APP_EXE and DSTUDIO_SCANNER_EXE override the executables to bundle (the release # workflow passes universal binaries). The plugin scanner goes next to the app executable in @@ -18,7 +18,7 @@ if [ -z "$scanner" ]; then scanner="$(ls -t "$(dirname "$exe")"/build/dstudio-engine-*/out/build/dstudio_plugin_scanner 2>/dev/null | head -1 || true)" fi version="$(sed -n 's/^version = "\(.*\)"/\1/p' "$root/Cargo.toml" | head -1)" -app="$out/Device Studio.app" +app="$out/Device.app" rm -rf "$app" mkdir -p "$app/Contents/MacOS" cp "$exe" "$app/Contents/MacOS/device-studio" @@ -32,8 +32,8 @@ cat > "$app/Contents/Info.plist" < - CFBundleNameDevice Studio - CFBundleDisplayNameDevice Studio + CFBundleNameDevice + CFBundleDisplayNameDevice CFBundleIdentifiercom.dstudio.studio CFBundleExecutabledevice-studio CFBundlePackageTypeAPPL @@ -41,7 +41,7 @@ cat > "$app/Contents/Info.plist" <CFBundleVersion$version LSMinimumSystemVersion13.0 NSHighResolutionCapable - NSMicrophoneUsageDescriptionDevice Studio records from your audio inputs. + NSMicrophoneUsageDescriptionDevice records from your audio inputs. PLIST diff --git a/tools/release/device-studio.iss b/tools/release/device-studio.iss index 0e20c0b8..12e6b5f4 100644 --- a/tools/release/device-studio.iss +++ b/tools/release/device-studio.iss @@ -1,4 +1,4 @@ -; Inno Setup script for the Device Studio Windows installer. +; Inno Setup script for the Device Windows installer. ; Built by tools/release/package-windows.ps1, which passes AppVersion, SourceDir (the staged ; app folder) and OutputDir. @@ -9,14 +9,15 @@ [Setup] ; A fixed id: later versions upgrade this install instead of adding a second one. AppId={{6C1C7F5E-3B47-4E0B-9C1F-5D2B8F0A4E61} -AppName=Device Studio +AppName=Device AppVersion={#AppVersion} -AppVerName=Device Studio {#AppVersion} -DefaultDirName={autopf}\Device Studio -DefaultGroupName=Device Studio +AppVerName=Device {#AppVersion} +DefaultDirName={autopf}\Device +DefaultGroupName=Device +UsePreviousGroup=no UninstallDisplayIcon={app}\device-studio.exe OutputDir={#OutputDir} -OutputBaseFilename=DeviceStudio-{#AppVersion}-windows-x64-setup +OutputBaseFilename=Device-{#AppVersion}-windows-x64-setup Compression=lzma2 SolidCompression=yes WizardStyle=modern @@ -36,9 +37,17 @@ Name: "desktopicon"; Description: "{cm:CreateDesktopIcon}"; GroupDescription: "{ Source: "{#SourceDir}\*"; DestDir: "{app}"; Flags: ignoreversion recursesubdirs [Icons] -Name: "{group}\Device Studio"; Filename: "{app}\device-studio.exe" -Name: "{group}\Uninstall Device Studio"; Filename: "{uninstallexe}" -Name: "{autodesktop}\Device Studio"; Filename: "{app}\device-studio.exe"; Tasks: desktopicon +Name: "{group}\Device"; Filename: "{app}\device-studio.exe" +Name: "{group}\Uninstall Device"; Filename: "{uninstallexe}" +Name: "{autodesktop}\Device"; Filename: "{app}\device-studio.exe"; Tasks: desktopicon + +; Remove the previous default shortcuts when upgrading the same AppId. Existing +; installation directories are reused by Inno Setup; user data is not moved. +[InstallDelete] +Type: files; Name: "{autoprograms}\Device Studio\Device Studio.lnk" +Type: files; Name: "{autoprograms}\Device Studio\Uninstall Device Studio.lnk" +Type: dirifempty; Name: "{autoprograms}\Device Studio" +Type: files; Name: "{autodesktop}\Device Studio.lnk" [Run] -Filename: "{app}\device-studio.exe"; Description: "{cm:LaunchProgram,Device Studio}"; Flags: nowait postinstall skipifsilent +Filename: "{app}\device-studio.exe"; Description: "{cm:LaunchProgram,Device}"; Flags: nowait postinstall skipifsilent diff --git a/tools/release/make-dmg.sh b/tools/release/make-dmg.sh index 673576d8..c3838792 100755 --- a/tools/release/make-dmg.sh +++ b/tools/release/make-dmg.sh @@ -1,5 +1,5 @@ #!/usr/bin/env bash -# Signs "Device Studio.app" and wraps it in a .dmg with an Applications link; notarises and +# Signs "Device.app" and wraps it in a .dmg with an Applications link; notarises and # staples the .dmg when credentials are given. # # Usage: tools/release/make-dmg.sh @@ -43,9 +43,9 @@ fi codesign --verify --strict --verbose=2 "$app" ln -s /Applications "$work/dmg/Applications" -dmg="$out/DeviceStudio-$version-macos-universal.dmg" +dmg="$out/Device-$version-macos-universal.dmg" rm -f "$dmg" -hdiutil create -volname "Device Studio $version" -srcfolder "$work/dmg" -fs HFS+ -format UDZO -ov "$dmg" +hdiutil create -volname "Device $version" -srcfolder "$work/dmg" -fs HFS+ -format UDZO -ov "$dmg" if [ -n "${MACOS_SIGN_IDENTITY:-}" ]; then codesign --force --timestamp --sign "$MACOS_SIGN_IDENTITY" "$dmg" diff --git a/tools/release/package-linux.sh b/tools/release/package-linux.sh index 2ef174ba..86446acf 100755 --- a/tools/release/package-linux.sh +++ b/tools/release/package-linux.sh @@ -1,5 +1,5 @@ #!/usr/bin/env bash -# Packages Device Studio for Linux: a .tar.gz with the app, the plugin scanner (the app looks +# Packages Device for Linux: a .tar.gz with the app, the plugin scanner (the app looks # for it next to itself), a desktop entry and an install script. # # Usage: tools/release/package-linux.sh @@ -11,7 +11,7 @@ arch="${2:?usage: package-linux.sh }" out="${3:?usage: package-linux.sh }" root="$(cd "$(dirname "$0")/../.." && pwd)" release="${CARGO_TARGET_DIR:-$root/target}/release" -name="DeviceStudio-$version-linux-$arch" +name="Device-$version-linux-$arch" work="$(mktemp -d)" trap 'rm -rf "$work"' EXIT stage="$work/$name" @@ -29,7 +29,7 @@ done cat > "$stage/share/applications/device-studio.desktop" < "$stage/install.sh" <<'INSTALL' #!/usr/bin/env sh -# Installs Device Studio for the current user (default prefix ~/.local) or, as root, for +# Installs Device for the current user (default prefix ~/.local) or, as root, for # everyone (PREFIX=/usr/local). Usage: ./install.sh [prefix] set -eu here="$(cd "$(dirname "$0")" && pwd)" diff --git a/tools/release/package-macos.sh b/tools/release/package-macos.sh index fa30e84b..d41a1ca0 100755 --- a/tools/release/package-macos.sh +++ b/tools/release/package-macos.sh @@ -1,8 +1,8 @@ #!/usr/bin/env bash -# Builds the universal (Apple silicon + Intel) "Device Studio.app" for macOS, unsigned apart +# Builds the universal (Apple silicon + Intel) "Device.app" for macOS, unsigned apart # from the linker's ad hoc signature. tools/release/make-dmg.sh signs it and wraps it in a .dmg. # -# Usage: tools/release/package-macos.sh (writes "/Device Studio.app") +# Usage: tools/release/package-macos.sh (writes "/Device.app") # Expects release builds of dstudio-app for both architectures: # cargo build --release --locked -p dstudio-app --target aarch64-apple-darwin # cargo build --release --locked -p dstudio-app --target x86_64-apple-darwin @@ -44,6 +44,6 @@ lipo -create -output "$work/dstudio_plugin_scanner" "$arm_scanner" "$x86_scanner chmod +x "$work/device-studio" "$work/dstudio_plugin_scanner" lipo -info "$work/device-studio" "$work/dstudio_plugin_scanner" -rm -rf "$out/Device Studio.app" +rm -rf "$out/Device.app" DSTUDIO_APP_EXE="$work/device-studio" DSTUDIO_SCANNER_EXE="$work/dstudio_plugin_scanner" \ bash "$root/tools/macos-bundle.sh" "$out" diff --git a/tools/release/package-windows.ps1 b/tools/release/package-windows.ps1 index b15f9cdd..41c1ed17 100644 --- a/tools/release/package-windows.ps1 +++ b/tools/release/package-windows.ps1 @@ -1,4 +1,4 @@ -# Packages Device Studio for Windows x64: a portable .zip and an Inno Setup installer. +# Packages Device for Windows x64: a portable .zip and an Inno Setup installer. # # Usage (from a Visual Studio x64 developer environment, after # cargo build --release --locked -p dstudio-app): @@ -19,7 +19,7 @@ $release = Join-Path $target 'release' New-Item -ItemType Directory -Force -Path $OutDir | Out-Null $OutDir = Resolve-Path $OutDir -$stage = Join-Path ([System.IO.Path]::GetTempPath()) "DeviceStudio-$Version" +$stage = Join-Path ([System.IO.Path]::GetTempPath()) "Device-$Version" if (Test-Path $stage) { Remove-Item -Recurse -Force $stage } New-Item -ItemType Directory -Path $stage | Out-Null @@ -42,7 +42,7 @@ foreach ($doc in 'LICENSE', 'README.md') { } Get-ChildItem $stage | Format-Table Name, Length -$zip = Join-Path $OutDir "DeviceStudio-$Version-windows-x64.zip" +$zip = Join-Path $OutDir "Device-$Version-windows-x64.zip" if (Test-Path $zip) { Remove-Item $zip } Compress-Archive -Path (Join-Path $stage '*') -DestinationPath $zip diff --git a/tools/release/smoke-macos.sh b/tools/release/smoke-macos.sh index 0f2f0c01..06c696a3 100755 --- a/tools/release/smoke-macos.sh +++ b/tools/release/smoke-macos.sh @@ -1,12 +1,12 @@ #!/usr/bin/env bash -# Mounts a Device Studio .dmg, checks the plugin scanner is bundled and that the app starts and +# Mounts a Device .dmg, checks the plugin scanner is bundled and that the app starts and # renders a screenshot. Usage: tools/release/smoke-macos.sh set -euo pipefail dmg="${1:?usage: smoke-macos.sh }" mnt=$(hdiutil attach -nobrowse -readonly "$dmg" | sed -n 's#.*\(/Volumes/.*\)#\1#p' | tail -1) [ -n "$mnt" ] || { echo "could not mount $dmg" >&2; exit 1; } trap 'hdiutil detach "$mnt" >/dev/null' EXIT -bin="$mnt/Device Studio.app/Contents/MacOS" +bin="$mnt/Device.app/Contents/MacOS" test -x "$bin/dstudio_plugin_scanner" shot="${RUNNER_TEMP:-/tmp}/device-studio-macos.png" "$bin/device-studio" --state reference-default --screenshot "$shot"