Update readme

This commit is contained in:
2026-03-14 02:58:59 +11:00
parent 3d68f08e1d
commit 9f6e607e78
4 changed files with 36 additions and 34 deletions

View File

@@ -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