diff --git a/.github/assets/bch-qr-placeholder.svg b/.github/assets/bch-qr-placeholder.svg new file mode 100644 index 0000000..7c0e26b --- /dev/null +++ b/.github/assets/bch-qr-placeholder.svg @@ -0,0 +1,11 @@ + + BCH QR placeholder + Placeholder card reminding the maintainer to replace this with a real BCH QR code. + + + + + + REPLACE WITH REAL BCH QR + ADD YOUR bitcoincash: ADDRESS + diff --git a/.github/assets/downterm-open.png b/.github/assets/downterm-open.png new file mode 100644 index 0000000..a9d8821 Binary files /dev/null and b/.github/assets/downterm-open.png differ diff --git a/.github/assets/downterm-settings.png b/.github/assets/downterm-settings.png new file mode 100644 index 0000000..306141d Binary files /dev/null and b/.github/assets/downterm-settings.png differ diff --git a/.gitignore b/.gitignore index 9ffbc2f..974c238 100644 --- a/.gitignore +++ b/.gitignore @@ -79,7 +79,5 @@ jspm_packages/ dist/ build/ -**/Release* -CommandNotch 20* - +# Mac... files **/.DS_Store \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4ee9c31 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,90 @@ +# Contributing + +Thanks for contributing to Downterm. + +## 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 +xcodegen generate --spec project.yml +open CommandNotch.xcodeproj +``` + +## Useful Commands + +Generate the project: + +```bash +cd Downterm +xcodegen generate --spec project.yml +``` + +Build: + +```bash +cd Downterm +DEVELOPER_DIR=/Applications/Xcode.app/Contents/Developer \ + xcodebuild build -project CommandNotch.xcodeproj -scheme CommandNotch -destination 'platform=macOS' +``` + +Run tests: + +```bash +cd Downterm +DEVELOPER_DIR=/Applications/Xcode.app/Contents/Developer \ + xcodebuild test -project CommandNotch.xcodeproj -scheme CommandNotch -destination 'platform=macOS' +``` + +## What Helps Most + +- Bug fixes with a clear reproduction path. +- UI polish that keeps the app feeling intentional instead of generic. +- Accessibility improvements. +- Tests around workspace, screen, settings, and hotkey behavior. +- Docs and onboarding improvements. + +## Code Guidelines + +- Keep changes targeted. +- Preserve the existing SwiftUI + AppKit split. +- Prefer typed settings and explicit state ownership over hidden side effects. +- Add or update tests when you change behavior. +- Regenerate the Xcode project with XcodeGen if you add or remove files. + +## Pull Requests + +- Keep PRs small enough to review comfortably. +- Explain the user-facing impact. +- Note any follow-up work or tradeoffs. +- Include screenshots for visible UI changes when possible. +- Mention the exact build/test command you used. + +## Issues + +When filing a bug, include: + +- macOS version +- what you expected +- what actually happened +- reproduction steps +- screenshots or recordings if they help + +## Media Updates + +README screenshots live in `.github/assets/`. + +If you update the UI significantly, refresh: + +- `.github/assets/downterm-open.png` +- `.github/assets/downterm-settings.png` + +## License + +By contributing, you agree that your contributions will be released under the MIT License in this repository. diff --git a/Downterm/CommandNotch.xcodeproj/project.pbxproj b/CommandNotch/CommandNotch.xcodeproj/project.pbxproj similarity index 100% rename from Downterm/CommandNotch.xcodeproj/project.pbxproj rename to CommandNotch/CommandNotch.xcodeproj/project.pbxproj diff --git a/Downterm/CommandNotch.xcodeproj/project.xcworkspace/contents.xcworkspacedata b/CommandNotch/CommandNotch.xcodeproj/project.xcworkspace/contents.xcworkspacedata similarity index 100% rename from Downterm/CommandNotch.xcodeproj/project.xcworkspace/contents.xcworkspacedata rename to CommandNotch/CommandNotch.xcodeproj/project.xcworkspace/contents.xcworkspacedata diff --git a/Downterm/CommandNotch.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved b/CommandNotch/CommandNotch.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved similarity index 100% rename from Downterm/CommandNotch.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved rename to CommandNotch/CommandNotch.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved diff --git a/Downterm/CommandNotch.xcodeproj/project.xcworkspace/xcuserdata/harvmaster.xcuserdatad/UserInterfaceState.xcuserstate b/CommandNotch/CommandNotch.xcodeproj/project.xcworkspace/xcuserdata/harvmaster.xcuserdatad/UserInterfaceState.xcuserstate similarity index 100% rename from Downterm/CommandNotch.xcodeproj/project.xcworkspace/xcuserdata/harvmaster.xcuserdatad/UserInterfaceState.xcuserstate rename to CommandNotch/CommandNotch.xcodeproj/project.xcworkspace/xcuserdata/harvmaster.xcuserdatad/UserInterfaceState.xcuserstate diff --git a/Downterm/CommandNotch.xcodeproj/xcshareddata/xcschemes/CommandNotch.xcscheme b/CommandNotch/CommandNotch.xcodeproj/xcshareddata/xcschemes/CommandNotch.xcscheme similarity index 100% rename from Downterm/CommandNotch.xcodeproj/xcshareddata/xcschemes/CommandNotch.xcscheme rename to CommandNotch/CommandNotch.xcodeproj/xcshareddata/xcschemes/CommandNotch.xcscheme diff --git a/Downterm/CommandNotch.xcodeproj/xcshareddata/xcschemes/Release-CommandNotch.xcscheme b/CommandNotch/CommandNotch.xcodeproj/xcshareddata/xcschemes/Release-CommandNotch.xcscheme similarity index 100% rename from Downterm/CommandNotch.xcodeproj/xcshareddata/xcschemes/Release-CommandNotch.xcscheme rename to CommandNotch/CommandNotch.xcodeproj/xcshareddata/xcschemes/Release-CommandNotch.xcscheme diff --git a/Downterm/CommandNotch.xcodeproj/xcuserdata/harvmaster.xcuserdatad/xcschemes/xcschememanagement.plist b/CommandNotch/CommandNotch.xcodeproj/xcuserdata/harvmaster.xcuserdatad/xcschemes/xcschememanagement.plist similarity index 100% rename from Downterm/CommandNotch.xcodeproj/xcuserdata/harvmaster.xcuserdatad/xcschemes/xcschememanagement.plist rename to CommandNotch/CommandNotch.xcodeproj/xcuserdata/harvmaster.xcuserdatad/xcschemes/xcschememanagement.plist diff --git a/Downterm/CommandNotch/AppDelegate.swift b/CommandNotch/CommandNotch/AppDelegate.swift similarity index 100% rename from Downterm/CommandNotch/AppDelegate.swift rename to CommandNotch/CommandNotch/AppDelegate.swift diff --git a/Downterm/CommandNotch/CommandNotchApp.swift b/CommandNotch/CommandNotch/CommandNotchApp.swift similarity index 100% rename from Downterm/CommandNotch/CommandNotchApp.swift rename to CommandNotch/CommandNotch/CommandNotchApp.swift diff --git a/Downterm/CommandNotch/Components/HotkeyRecorderView.swift b/CommandNotch/CommandNotch/Components/HotkeyRecorderView.swift similarity index 100% rename from Downterm/CommandNotch/Components/HotkeyRecorderView.swift rename to CommandNotch/CommandNotch/Components/HotkeyRecorderView.swift diff --git a/Downterm/CommandNotch/Components/NotchShape.swift b/CommandNotch/CommandNotch/Components/NotchShape.swift similarity index 100% rename from Downterm/CommandNotch/Components/NotchShape.swift rename to CommandNotch/CommandNotch/Components/NotchShape.swift diff --git a/Downterm/CommandNotch/Components/NotchWindow.swift b/CommandNotch/CommandNotch/Components/NotchWindow.swift similarity index 100% rename from Downterm/CommandNotch/Components/NotchWindow.swift rename to CommandNotch/CommandNotch/Components/NotchWindow.swift diff --git a/Downterm/CommandNotch/Components/SwiftTermView.swift b/CommandNotch/CommandNotch/Components/SwiftTermView.swift similarity index 100% rename from Downterm/CommandNotch/Components/SwiftTermView.swift rename to CommandNotch/CommandNotch/Components/SwiftTermView.swift diff --git a/Downterm/CommandNotch/Components/TabBar.swift b/CommandNotch/CommandNotch/Components/TabBar.swift similarity index 100% rename from Downterm/CommandNotch/Components/TabBar.swift rename to CommandNotch/CommandNotch/Components/TabBar.swift diff --git a/Downterm/CommandNotch/Components/TerminalCommandArrowBehavior.swift b/CommandNotch/CommandNotch/Components/TerminalCommandArrowBehavior.swift similarity index 100% rename from Downterm/CommandNotch/Components/TerminalCommandArrowBehavior.swift rename to CommandNotch/CommandNotch/Components/TerminalCommandArrowBehavior.swift diff --git a/Downterm/CommandNotch/ContentView.swift b/CommandNotch/CommandNotch/ContentView.swift similarity index 100% rename from Downterm/CommandNotch/ContentView.swift rename to CommandNotch/CommandNotch/ContentView.swift diff --git a/Downterm/CommandNotch/Extensions/NSScreen+Extensions.swift b/CommandNotch/CommandNotch/Extensions/NSScreen+Extensions.swift similarity index 100% rename from Downterm/CommandNotch/Extensions/NSScreen+Extensions.swift rename to CommandNotch/CommandNotch/Extensions/NSScreen+Extensions.swift diff --git a/Downterm/CommandNotch/Managers/HotkeyManager.swift b/CommandNotch/CommandNotch/Managers/HotkeyManager.swift similarity index 100% rename from Downterm/CommandNotch/Managers/HotkeyManager.swift rename to CommandNotch/CommandNotch/Managers/HotkeyManager.swift diff --git a/Downterm/CommandNotch/Managers/LaunchAtLoginHelper.swift b/CommandNotch/CommandNotch/Managers/LaunchAtLoginHelper.swift similarity index 100% rename from Downterm/CommandNotch/Managers/LaunchAtLoginHelper.swift rename to CommandNotch/CommandNotch/Managers/LaunchAtLoginHelper.swift diff --git a/Downterm/CommandNotch/Managers/PopoutWindowController.swift b/CommandNotch/CommandNotch/Managers/PopoutWindowController.swift similarity index 100% rename from Downterm/CommandNotch/Managers/PopoutWindowController.swift rename to CommandNotch/CommandNotch/Managers/PopoutWindowController.swift diff --git a/Downterm/CommandNotch/Managers/ScreenManager.swift b/CommandNotch/CommandNotch/Managers/ScreenManager.swift similarity index 100% rename from Downterm/CommandNotch/Managers/ScreenManager.swift rename to CommandNotch/CommandNotch/Managers/ScreenManager.swift diff --git a/Downterm/CommandNotch/Managers/SettingsWindowController.swift b/CommandNotch/CommandNotch/Managers/SettingsWindowController.swift similarity index 100% rename from Downterm/CommandNotch/Managers/SettingsWindowController.swift rename to CommandNotch/CommandNotch/Managers/SettingsWindowController.swift diff --git a/Downterm/CommandNotch/Managers/WindowCoordinator.swift b/CommandNotch/CommandNotch/Managers/WindowCoordinator.swift similarity index 100% rename from Downterm/CommandNotch/Managers/WindowCoordinator.swift rename to CommandNotch/CommandNotch/Managers/WindowCoordinator.swift diff --git a/Downterm/CommandNotch/Models/AppSettings.swift b/CommandNotch/CommandNotch/Models/AppSettings.swift similarity index 100% rename from Downterm/CommandNotch/Models/AppSettings.swift rename to CommandNotch/CommandNotch/Models/AppSettings.swift diff --git a/Downterm/CommandNotch/Models/AppSettingsController.swift b/CommandNotch/CommandNotch/Models/AppSettingsController.swift similarity index 100% rename from Downterm/CommandNotch/Models/AppSettingsController.swift rename to CommandNotch/CommandNotch/Models/AppSettingsController.swift diff --git a/Downterm/CommandNotch/Models/AppSettingsStore.swift b/CommandNotch/CommandNotch/Models/AppSettingsStore.swift similarity index 100% rename from Downterm/CommandNotch/Models/AppSettingsStore.swift rename to CommandNotch/CommandNotch/Models/AppSettingsStore.swift diff --git a/Downterm/CommandNotch/Models/HotkeyBinding.swift b/CommandNotch/CommandNotch/Models/HotkeyBinding.swift similarity index 100% rename from Downterm/CommandNotch/Models/HotkeyBinding.swift rename to CommandNotch/CommandNotch/Models/HotkeyBinding.swift diff --git a/Downterm/CommandNotch/Models/NotchOrchestrator.swift b/CommandNotch/CommandNotch/Models/NotchOrchestrator.swift similarity index 100% rename from Downterm/CommandNotch/Models/NotchOrchestrator.swift rename to CommandNotch/CommandNotch/Models/NotchOrchestrator.swift diff --git a/Downterm/CommandNotch/Models/NotchSettings.swift b/CommandNotch/CommandNotch/Models/NotchSettings.swift similarity index 100% rename from Downterm/CommandNotch/Models/NotchSettings.swift rename to CommandNotch/CommandNotch/Models/NotchSettings.swift diff --git a/Downterm/CommandNotch/Models/NotchState.swift b/CommandNotch/CommandNotch/Models/NotchState.swift similarity index 100% rename from Downterm/CommandNotch/Models/NotchState.swift rename to CommandNotch/CommandNotch/Models/NotchState.swift diff --git a/Downterm/CommandNotch/Models/ScreenContext.swift b/CommandNotch/CommandNotch/Models/ScreenContext.swift similarity index 100% rename from Downterm/CommandNotch/Models/ScreenContext.swift rename to CommandNotch/CommandNotch/Models/ScreenContext.swift diff --git a/Downterm/CommandNotch/Models/ScreenRegistry.swift b/CommandNotch/CommandNotch/Models/ScreenRegistry.swift similarity index 100% rename from Downterm/CommandNotch/Models/ScreenRegistry.swift rename to CommandNotch/CommandNotch/Models/ScreenRegistry.swift diff --git a/Downterm/CommandNotch/Models/TerminalManager.swift b/CommandNotch/CommandNotch/Models/TerminalManager.swift similarity index 100% rename from Downterm/CommandNotch/Models/TerminalManager.swift rename to CommandNotch/CommandNotch/Models/TerminalManager.swift diff --git a/Downterm/CommandNotch/Models/TerminalSession.swift b/CommandNotch/CommandNotch/Models/TerminalSession.swift similarity index 100% rename from Downterm/CommandNotch/Models/TerminalSession.swift rename to CommandNotch/CommandNotch/Models/TerminalSession.swift diff --git a/Downterm/CommandNotch/Models/TerminalTheme.swift b/CommandNotch/CommandNotch/Models/TerminalTheme.swift similarity index 100% rename from Downterm/CommandNotch/Models/TerminalTheme.swift rename to CommandNotch/CommandNotch/Models/TerminalTheme.swift diff --git a/Downterm/CommandNotch/Models/WorkspaceController.swift b/CommandNotch/CommandNotch/Models/WorkspaceController.swift similarity index 100% rename from Downterm/CommandNotch/Models/WorkspaceController.swift rename to CommandNotch/CommandNotch/Models/WorkspaceController.swift diff --git a/Downterm/CommandNotch/Models/WorkspaceRegistry.swift b/CommandNotch/CommandNotch/Models/WorkspaceRegistry.swift similarity index 100% rename from Downterm/CommandNotch/Models/WorkspaceRegistry.swift rename to CommandNotch/CommandNotch/Models/WorkspaceRegistry.swift diff --git a/Downterm/CommandNotch/Models/WorkspaceStore.swift b/CommandNotch/CommandNotch/Models/WorkspaceStore.swift similarity index 100% rename from Downterm/CommandNotch/Models/WorkspaceStore.swift rename to CommandNotch/CommandNotch/Models/WorkspaceStore.swift diff --git a/Downterm/CommandNotch/Models/WorkspaceSummary.swift b/CommandNotch/CommandNotch/Models/WorkspaceSummary.swift similarity index 100% rename from Downterm/CommandNotch/Models/WorkspaceSummary.swift rename to CommandNotch/CommandNotch/Models/WorkspaceSummary.swift diff --git a/Downterm/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/Contents.json b/CommandNotch/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/Contents.json similarity index 100% rename from Downterm/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/Contents.json rename to CommandNotch/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/Contents.json diff --git a/Downterm/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_128x128.png b/CommandNotch/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_128x128.png similarity index 100% rename from Downterm/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_128x128.png rename to CommandNotch/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_128x128.png diff --git a/Downterm/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_128x128@2x.png b/CommandNotch/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_128x128@2x.png similarity index 100% rename from Downterm/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_128x128@2x.png rename to CommandNotch/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_128x128@2x.png diff --git a/Downterm/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_16x16.png b/CommandNotch/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_16x16.png similarity index 100% rename from Downterm/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_16x16.png rename to CommandNotch/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_16x16.png diff --git a/Downterm/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_16x16@2x.png b/CommandNotch/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_16x16@2x.png similarity index 100% rename from Downterm/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_16x16@2x.png rename to CommandNotch/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_16x16@2x.png diff --git a/Downterm/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_256x256.png b/CommandNotch/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_256x256.png similarity index 100% rename from Downterm/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_256x256.png rename to CommandNotch/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_256x256.png diff --git a/Downterm/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_256x256@2x.png b/CommandNotch/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_256x256@2x.png similarity index 100% rename from Downterm/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_256x256@2x.png rename to CommandNotch/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_256x256@2x.png diff --git a/Downterm/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_32x32.png b/CommandNotch/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_32x32.png similarity index 100% rename from Downterm/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_32x32.png rename to CommandNotch/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_32x32.png diff --git a/Downterm/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_32x32@2x.png b/CommandNotch/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_32x32@2x.png similarity index 100% rename from Downterm/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_32x32@2x.png rename to CommandNotch/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_32x32@2x.png diff --git a/Downterm/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_512x512.png b/CommandNotch/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_512x512.png similarity index 100% rename from Downterm/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_512x512.png rename to CommandNotch/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_512x512.png diff --git a/Downterm/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_512x512@2x.png b/CommandNotch/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_512x512@2x.png similarity index 100% rename from Downterm/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_512x512@2x.png rename to CommandNotch/CommandNotch/Resources/Assets.xcassets/AppIcon.appiconset/icon_512x512@2x.png diff --git a/Downterm/CommandNotch/Resources/Assets.xcassets/Contents.json b/CommandNotch/CommandNotch/Resources/Assets.xcassets/Contents.json similarity index 100% rename from Downterm/CommandNotch/Resources/Assets.xcassets/Contents.json rename to CommandNotch/CommandNotch/Resources/Assets.xcassets/Contents.json diff --git a/Downterm/CommandNotch/Resources/CommandNotch.entitlements b/CommandNotch/CommandNotch/Resources/CommandNotch.entitlements similarity index 100% rename from Downterm/CommandNotch/Resources/CommandNotch.entitlements rename to CommandNotch/CommandNotch/Resources/CommandNotch.entitlements diff --git a/Downterm/CommandNotch/Resources/Info.plist b/CommandNotch/CommandNotch/Resources/Info.plist similarity index 100% rename from Downterm/CommandNotch/Resources/Info.plist rename to CommandNotch/CommandNotch/Resources/Info.plist diff --git a/Downterm/CommandNotch/Views/AboutSettingsView.swift b/CommandNotch/CommandNotch/Views/AboutSettingsView.swift similarity index 100% rename from Downterm/CommandNotch/Views/AboutSettingsView.swift rename to CommandNotch/CommandNotch/Views/AboutSettingsView.swift diff --git a/Downterm/CommandNotch/Views/AnimationSettingsView.swift b/CommandNotch/CommandNotch/Views/AnimationSettingsView.swift similarity index 100% rename from Downterm/CommandNotch/Views/AnimationSettingsView.swift rename to CommandNotch/CommandNotch/Views/AnimationSettingsView.swift diff --git a/Downterm/CommandNotch/Views/AppearanceSettingsView.swift b/CommandNotch/CommandNotch/Views/AppearanceSettingsView.swift similarity index 100% rename from Downterm/CommandNotch/Views/AppearanceSettingsView.swift rename to CommandNotch/CommandNotch/Views/AppearanceSettingsView.swift diff --git a/Downterm/CommandNotch/Views/GeneralSettingsView.swift b/CommandNotch/CommandNotch/Views/GeneralSettingsView.swift similarity index 100% rename from Downterm/CommandNotch/Views/GeneralSettingsView.swift rename to CommandNotch/CommandNotch/Views/GeneralSettingsView.swift diff --git a/Downterm/CommandNotch/Views/HotkeySettingsView.swift b/CommandNotch/CommandNotch/Views/HotkeySettingsView.swift similarity index 100% rename from Downterm/CommandNotch/Views/HotkeySettingsView.swift rename to CommandNotch/CommandNotch/Views/HotkeySettingsView.swift diff --git a/Downterm/CommandNotch/Views/SettingsBindings.swift b/CommandNotch/CommandNotch/Views/SettingsBindings.swift similarity index 100% rename from Downterm/CommandNotch/Views/SettingsBindings.swift rename to CommandNotch/CommandNotch/Views/SettingsBindings.swift diff --git a/Downterm/CommandNotch/Views/SettingsView.swift b/CommandNotch/CommandNotch/Views/SettingsView.swift similarity index 100% rename from Downterm/CommandNotch/Views/SettingsView.swift rename to CommandNotch/CommandNotch/Views/SettingsView.swift diff --git a/Downterm/CommandNotch/Views/TerminalSettingsView.swift b/CommandNotch/CommandNotch/Views/TerminalSettingsView.swift similarity index 100% rename from Downterm/CommandNotch/Views/TerminalSettingsView.swift rename to CommandNotch/CommandNotch/Views/TerminalSettingsView.swift diff --git a/Downterm/CommandNotch/Views/WorkspaceSwitcherView.swift b/CommandNotch/CommandNotch/Views/WorkspaceSwitcherView.swift similarity index 100% rename from Downterm/CommandNotch/Views/WorkspaceSwitcherView.swift rename to CommandNotch/CommandNotch/Views/WorkspaceSwitcherView.swift diff --git a/Downterm/CommandNotch/Views/WorkspacesSettingsView.swift b/CommandNotch/CommandNotch/Views/WorkspacesSettingsView.swift similarity index 100% rename from Downterm/CommandNotch/Views/WorkspacesSettingsView.swift rename to CommandNotch/CommandNotch/Views/WorkspacesSettingsView.swift diff --git a/Downterm/CommandNotchTests/AppSettingsControllerTests.swift b/CommandNotch/CommandNotchTests/AppSettingsControllerTests.swift similarity index 100% rename from Downterm/CommandNotchTests/AppSettingsControllerTests.swift rename to CommandNotch/CommandNotchTests/AppSettingsControllerTests.swift diff --git a/Downterm/CommandNotchTests/AppSettingsStoreTests.swift b/CommandNotch/CommandNotchTests/AppSettingsStoreTests.swift similarity index 100% rename from Downterm/CommandNotchTests/AppSettingsStoreTests.swift rename to CommandNotch/CommandNotchTests/AppSettingsStoreTests.swift diff --git a/Downterm/CommandNotchTests/NotchOrchestratorTests.swift b/CommandNotch/CommandNotchTests/NotchOrchestratorTests.swift similarity index 100% rename from Downterm/CommandNotchTests/NotchOrchestratorTests.swift rename to CommandNotch/CommandNotchTests/NotchOrchestratorTests.swift diff --git a/Downterm/CommandNotchTests/ScreenContextTests.swift b/CommandNotch/CommandNotchTests/ScreenContextTests.swift similarity index 100% rename from Downterm/CommandNotchTests/ScreenContextTests.swift rename to CommandNotch/CommandNotchTests/ScreenContextTests.swift diff --git a/Downterm/CommandNotchTests/ScreenRegistryTests.swift b/CommandNotch/CommandNotchTests/ScreenRegistryTests.swift similarity index 100% rename from Downterm/CommandNotchTests/ScreenRegistryTests.swift rename to CommandNotch/CommandNotchTests/ScreenRegistryTests.swift diff --git a/Downterm/CommandNotchTests/TerminalCommandArrowBehaviorTests.swift b/CommandNotch/CommandNotchTests/TerminalCommandArrowBehaviorTests.swift similarity index 100% rename from Downterm/CommandNotchTests/TerminalCommandArrowBehaviorTests.swift rename to CommandNotch/CommandNotchTests/TerminalCommandArrowBehaviorTests.swift diff --git a/Downterm/CommandNotchTests/WindowFrameCalculatorTests.swift b/CommandNotch/CommandNotchTests/WindowFrameCalculatorTests.swift similarity index 100% rename from Downterm/CommandNotchTests/WindowFrameCalculatorTests.swift rename to CommandNotch/CommandNotchTests/WindowFrameCalculatorTests.swift diff --git a/Downterm/CommandNotchTests/WorkspaceRegistryTests.swift b/CommandNotch/CommandNotchTests/WorkspaceRegistryTests.swift similarity index 100% rename from Downterm/CommandNotchTests/WorkspaceRegistryTests.swift rename to CommandNotch/CommandNotchTests/WorkspaceRegistryTests.swift diff --git a/Downterm/CommandNotchTests/WorkspaceStoreTests.swift b/CommandNotch/CommandNotchTests/WorkspaceStoreTests.swift similarity index 100% rename from Downterm/CommandNotchTests/WorkspaceStoreTests.swift rename to CommandNotch/CommandNotchTests/WorkspaceStoreTests.swift diff --git a/Downterm/CommandNotchUITests/CommandNotchUITests.swift b/CommandNotch/CommandNotchUITests/CommandNotchUITests.swift similarity index 100% rename from Downterm/CommandNotchUITests/CommandNotchUITests.swift rename to CommandNotch/CommandNotchUITests/CommandNotchUITests.swift diff --git a/Downterm/Downterm.xcodeproj/project.xcworkspace/contents.xcworkspacedata b/CommandNotch/Downterm.xcodeproj/project.xcworkspace/contents.xcworkspacedata similarity index 100% rename from Downterm/Downterm.xcodeproj/project.xcworkspace/contents.xcworkspacedata rename to CommandNotch/Downterm.xcodeproj/project.xcworkspace/contents.xcworkspacedata diff --git a/Downterm/Downterm.xcodeproj/project.xcworkspace/xcuserdata/harvmaster.xcuserdatad/UserInterfaceState.xcuserstate b/CommandNotch/Downterm.xcodeproj/project.xcworkspace/xcuserdata/harvmaster.xcuserdatad/UserInterfaceState.xcuserstate similarity index 100% rename from Downterm/Downterm.xcodeproj/project.xcworkspace/xcuserdata/harvmaster.xcuserdatad/UserInterfaceState.xcuserstate rename to CommandNotch/Downterm.xcodeproj/project.xcworkspace/xcuserdata/harvmaster.xcuserdatad/UserInterfaceState.xcuserstate diff --git a/Downterm/project.yml b/CommandNotch/project.yml similarity index 100% rename from Downterm/project.yml rename to CommandNotch/project.yml diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e66c57b --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Harvey Zuccon + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..4e94c0b --- /dev/null +++ b/README.md @@ -0,0 +1,108 @@ +# Downterm + +

+ Downterm icon +

+ +

+ A drop-down terminal for macOS that lives in the notch area. +

+ +

+ macOS 14+ + SwiftUI and AppKit + 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. + +The current Xcode target and bundle name are still `CommandNotch`, but the project is being presented publicly as **Downterm**. + +## Why Downterm + +- 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. +- You work across multiple displays and want each screen to keep its own notch state. +- You want lightweight workspaces, detachable tabs, and shell access without giving up native macOS feel. + +## Features + +- Native macOS notch overlay with open and closed states. +- Fast shell sessions powered by SwiftTerm and a local login shell. +- Multiple tabs with hotkeys for new, close, next, previous, and direct tab switching. +- Workspace support, including shared workspaces across screens. +- Multi-display awareness with per-screen assignment and presentation state. +- Detachable tabs that can pop out into standalone terminal windows. +- Terminal themes: Classic, Xterm, Solarized Dark, Dracula, and Nord. +- Configurable terminal size presets with optional hotkeys. +- Hover-to-open behavior and animation tuning. +- Launch at login support. +- Global toggle hotkey and notch-scoped shortcut handling. +- Terminal-friendly macOS key behavior for `Command+Arrow`, `Option+Arrow`, `Command+Backspace`, and `Command+L`. + +## Gallery + +### Open Notch Terminal + +![Downterm open notch terminal](.github/assets/downterm-open.png) + +### Settings + +![Downterm settings window](.github/assets/downterm-settings.png) + +## Getting Started + +### Requirements + +- macOS 14 or later +- Xcode 16 or later +- Homebrew `xcodegen` + +### Build + +```bash +cd Downterm +xcodegen generate --spec project.yml +open CommandNotch.xcodeproj +``` + +Or from the command line: + +```bash +cd Downterm +xcodegen generate --spec project.yml +DEVELOPER_DIR=/Applications/Xcode.app/Contents/Developer \ + xcodebuild build -project CommandNotch.xcodeproj -scheme CommandNotch -destination 'platform=macOS' +``` + +## Project Layout + +```text +Downterm/ +├── Downterm/ # XcodeGen spec, app target, tests +├── docs/ # architecture and planning notes +├── icons/ # app icons and branding assets +└── .github/assets/ # README screenshots and support assets +``` + +## Contributing + +Contributions are welcome. If you want to fix bugs, improve the UX, tighten the architecture, or help polish the public release, start with [CONTRIBUTING.md](CONTRIBUTING.md). + +## Help Fund Development + +If Downterm 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. + +

+ Placeholder BCH QR card +

+ +## License + +Downterm is released under the [MIT License](LICENSE).