Browse Source

add documentation

pull/133/head
Trent Larson 3 weeks ago
parent
commit
748c4c7a50
  1. 4
      .gitignore
  2. 18
      BUILDING.md

4
.gitignore

@ -42,7 +42,7 @@ dist-electron-packages
.ruby-version
+.env
# Generated test files
# Test files generated by scripts test-ios.js & test-android.js
.generated/
.env.default
@ -54,4 +54,4 @@ build_logs/
android/app/src/main/assets/public
android/app/src/main/res
android/.gradle/buildOutputCleanup/buildOutputCleanup.lock
android/.gradle/file-system.probe
android/.gradle/file-system.probe

18
BUILDING.md

@ -11,7 +11,7 @@ For a quick dev environment setup, use [pkgx](https://pkgx.dev).
- Git
- For Android builds: Android Studio with SDK installed
- For iOS builds: macOS with Xcode and ruby gems & bundle
- pkgx +rubygems.org sh
- `pkgx +rubygems.org sh`
- ... and you may have to fix these, especially with pkgx
@ -327,6 +327,7 @@ Prerequisites: macOS with Xcode installed
1. Build the web assets:
```bash
npm run build:web
npm run build:capacitor
```
@ -351,6 +352,13 @@ Prerequisites: macOS with Xcode installed
4. Use Xcode to build and run on simulator or device.
5. Release
* Under "General" renamed a bunch of things to "Time Safari"
* Choose Product -> Destination -> Any iOS
* Choose Product -> Archive (which will trigger a build and take time, and "login" keychain password is machine user login, repeatedly)
* Click Distribute
#### First-time iOS Configuration
- Generate certificates inside XCode.
@ -370,6 +378,7 @@ Prerequisites: Android Studio with SDK installed
cd android
./gradlew clean
./gradlew assembleDebug
cd ..
```
2. Update Android project with latest build:
@ -408,12 +417,17 @@ Prerequisites: Android Studio with SDK installed
./gradlew bundleDebug -Dlint.baselines.continue=true
```
... or, to create a signed release, add the app/gradle.properties.secrets file (see properties at top of app/build.gradle) and the app/time-safari-upload-key-pkcs12.jks file, then `bundleRelease`:
... or, to create a signed release:
* Setup by adding the app/gradle.properties.secrets file (see properties at top of app/build.gradle) and the app/time-safari-upload-key-pkcs12.jks file
* In app/build.gradle, bump the versionCode and maybe the versionName
* Then `bundleRelease`:
```bash
./gradlew bundleRelease -Dlint.baselines.continue=true
```
... and find your `aab` file at app/build/outputs/bundle/release
## First-time Android Configuration for deep links

Loading…
Cancel
Save