Skip to content

Commit 9427c8c

Browse files
docs (README.md): add taskfile instructions, update vanilla npm/npx commands
1 parent 38b5fe3 commit 9427c8c

1 file changed

Lines changed: 61 additions & 4 deletions

File tree

README.md

Lines changed: 61 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,18 +40,75 @@ lunchjs/
4040

4141
## Development
4242

43+
### Prerequisites
44+
45+
1. **Install Node.js and Rust**:
46+
```bash
47+
mise install
48+
```
49+
50+
If you encounter GPG signature verification errors, import the Node.js release key:
51+
```bash
52+
gpg --keyserver hkps://keys.openpgp.org --recv-keys 86C8D74642E67846F8E120284DAA80D1E737BC9F
53+
```
54+
55+
2. **Install dependencies**:
56+
```bash
57+
npm install
58+
```
59+
60+
3. **Install iOS targets** (for mobile development):
61+
```bash
62+
rustup target add aarch64-apple-ios x86_64-apple-ios aarch64-apple-ios-sim
63+
```
64+
65+
### Running the app
66+
67+
#### Using Taskfile (recommended)
68+
4369
```bash
44-
# Install iOS targets
45-
rustup target add aarch64-apple-ios x86_64-apple-ios aarch64-apple-ios-sim
70+
# Development (macOS)
71+
task dev
72+
73+
# Development (iOS simulator)
74+
task ios
75+
76+
# Development (physical iOS device)
77+
task ios:device
4678

79+
# Build (macOS - current architecture)
80+
task build
81+
82+
# Build (macOS - Apple Silicon)
83+
task build:arm64
84+
85+
# Build (macOS - Intel)
86+
task build:x64
87+
88+
# Build (iOS for App Store)
89+
task ios:build
90+
91+
# Upload to TestFlight
92+
task ios:testflight
93+
94+
# Upload to App Store
95+
task ios:release
96+
97+
# Clean build artifacts
98+
task clean
99+
```
100+
101+
#### Using npm/npx directly
102+
103+
```bash
47104
# Development (macOS)
48-
cd src-tauri && npx tauri dev
105+
npx tauri dev
49106

50107
# Development (iOS simulator)
51108
cd src-tauri && npx tauri ios dev
52109

53110
# Build (macOS)
54-
cd src-tauri && npx tauri build
111+
npx tauri build
55112

56113
# Build (iOS)
57114
cd src-tauri && npx tauri ios build

0 commit comments

Comments
 (0)