From 9f6e607e78910c4232f8b47ee8fc018118bab54c Mon Sep 17 00:00:00 2001 From: Harvey Zuccon Date: Sat, 14 Mar 2026 02:58:59 +1100 Subject: [PATCH] Update readme --- CONTRIBUTING.md | 15 +++++------ README.md | 41 ++++++++++++++++------------- docs/workspace-architecture-spec.md | 2 +- docs/workspace-split-pane-plan.md | 12 ++++----- 4 files changed, 36 insertions(+), 34 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4ee9c31..4068a5b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,18 +1,17 @@ # Contributing -Thanks for contributing to Downterm. +Thanks for contributing to CommandNotch. ## Before You Start - Use macOS 14+. - Install Xcode 16+. - Install `xcodegen` with Homebrew. -- Expect the app target to still be named `CommandNotch` while the public project name is Downterm. ## Local Setup ```bash -cd Downterm +cd CommandNotch xcodegen generate --spec project.yml open CommandNotch.xcodeproj ``` @@ -22,14 +21,14 @@ open CommandNotch.xcodeproj Generate the project: ```bash -cd Downterm +cd CommandNotch xcodegen generate --spec project.yml ``` Build: ```bash -cd Downterm +cd CommandNotch DEVELOPER_DIR=/Applications/Xcode.app/Contents/Developer \ xcodebuild build -project CommandNotch.xcodeproj -scheme CommandNotch -destination 'platform=macOS' ``` @@ -37,7 +36,7 @@ DEVELOPER_DIR=/Applications/Xcode.app/Contents/Developer \ Run tests: ```bash -cd Downterm +cd CommandNotch DEVELOPER_DIR=/Applications/Xcode.app/Contents/Developer \ xcodebuild test -project CommandNotch.xcodeproj -scheme CommandNotch -destination 'platform=macOS' ``` @@ -82,8 +81,8 @@ README screenshots live in `.github/assets/`. If you update the UI significantly, refresh: -- `.github/assets/downterm-open.png` -- `.github/assets/downterm-settings.png` +- `.github/assets/CommandNotch-Open.png` +- `.github/assets/CommandNotch-Settings.png` ## License diff --git a/README.md b/README.md index 4e94c0b..9adb230 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -# Downterm +# CommandNotch

- Downterm icon + CommandNotch icon

@@ -14,11 +14,11 @@ MIT License

-Downterm is a notch-native terminal overlay for macOS. It gives you a fast shell without switching spaces, keeping a full Terminal window open, or breaking your flow. Open it with a hotkey, drop into a shell, then get out of the way just as quickly. +CommandNotch is a notch-native terminal overlay for macOS. It gives you a fast shell without switching spaces, keeping a full Terminal window open, or breaking your flow. Open it with a hotkey, drop into a shell, then get out of the way just as quickly. -The current Xcode target and bundle name are still `CommandNotch`, but the project is being presented publicly as **Downterm**. +The current Xcode target and bundle name are still `CommandNotch`, but the project is being presented publicly as **CommandNotch**. -## Why Downterm +## Why CommandNotch - You want a terminal that is always one shortcut away. - You like the idea of a terminal living in the menu bar / notch area instead of a full window. @@ -42,13 +42,19 @@ The current Xcode target and bundle name are still `CommandNotch`, but the proje ## Gallery +### Demo + +[![CommandNotch demo video](.github/assets/CommandNotch-Open.png)](.github/assets/CommandNotch-Demo.mp4) + +Click the preview above to watch the demo recording. + ### Open Notch Terminal -![Downterm open notch terminal](.github/assets/downterm-open.png) +![CommandNotch open notch terminal](.github/assets/CommandNotch-Open.png) ### Settings -![Downterm settings window](.github/assets/downterm-settings.png) +![CommandNotch settings window](.github/assets/CommandNotch-Settings.png) ## Getting Started @@ -61,7 +67,7 @@ The current Xcode target and bundle name are still `CommandNotch`, but the proje ### Build ```bash -cd Downterm +cd CommandNotch xcodegen generate --spec project.yml open CommandNotch.xcodeproj ``` @@ -69,7 +75,7 @@ open CommandNotch.xcodeproj Or from the command line: ```bash -cd Downterm +cd CommandNotch xcodegen generate --spec project.yml DEVELOPER_DIR=/Applications/Xcode.app/Contents/Developer \ xcodebuild build -project CommandNotch.xcodeproj -scheme CommandNotch -destination 'platform=macOS' @@ -78,8 +84,8 @@ DEVELOPER_DIR=/Applications/Xcode.app/Contents/Developer \ ## Project Layout ```text -Downterm/ -├── Downterm/ # XcodeGen spec, app target, tests +CommandNotch/ +├── CommandNotch/ # XcodeGen spec, app target, tests ├── docs/ # architecture and planning notes ├── icons/ # app icons and branding assets └── .github/assets/ # README screenshots and support assets @@ -91,18 +97,15 @@ Contributions are welcome. If you want to fix bugs, improve the UX, tighten the ## Help Fund Development -If Downterm saves you time, support helps justify more polish and faster iteration. +If CommandNotch saves you time, support helps justify more polish and faster iteration. -- Ko-fi: `ADD_YOUR_KOFI_LINK_HERE` -- BCH: `ADD_YOUR_BCH_ADDRESS_HERE` - -> Funding placeholders are intentionally left unfinalized until the maintainer adds the real Ko-fi URL and BCH address. -> Replace the BCH placeholder above and swap in a real QR image before publishing this section widely. +- Ko-fi: https://ko-fi.com/harvmaster +- BCH: `bitcoincash:zq5xlhahsk8svzk562m3kwrzgd9hrm80mcu8slnzv3`

- Placeholder BCH QR card + BCH receiving address QR code

## License -Downterm is released under the [MIT License](LICENSE). +CommandNotch is released under the [MIT License](LICENSE). diff --git a/docs/workspace-architecture-spec.md b/docs/workspace-architecture-spec.md index 0061eab..0e16d0e 100644 --- a/docs/workspace-architecture-spec.md +++ b/docs/workspace-architecture-spec.md @@ -618,7 +618,7 @@ Exit criteria: ## Proposed File Layout ```text -Downterm/CommandNotch/ +CommandNotch/CommandNotch/ App/ CommandNotchApp.swift AppDelegate.swift diff --git a/docs/workspace-split-pane-plan.md b/docs/workspace-split-pane-plan.md index a534020..9eb6717 100644 --- a/docs/workspace-split-pane-plan.md +++ b/docs/workspace-split-pane-plan.md @@ -321,12 +321,12 @@ The first deliverable should not include: ## Files Likely Impacted -- `Downterm/CommandNotch/Models/WorkspaceController.swift` -- `Downterm/CommandNotch/Models/WorkspaceRegistry.swift` -- `Downterm/CommandNotch/Models/WorkspaceStore.swift` -- `Downterm/CommandNotch/ContentView.swift` -- `Downterm/CommandNotch/Components/TabBar.swift` -- `Downterm/CommandNotch/Models/TerminalSession.swift` +- `CommandNotch/CommandNotch/Models/WorkspaceController.swift` +- `CommandNotch/CommandNotch/Models/WorkspaceRegistry.swift` +- `CommandNotch/CommandNotch/Models/WorkspaceStore.swift` +- `CommandNotch/CommandNotch/ContentView.swift` +- `CommandNotch/CommandNotch/Components/TabBar.swift` +- `CommandNotch/CommandNotch/Models/TerminalSession.swift` - workspace-related tests Likely new files: