forked from Blendman974/faceclaw
Refactor build scripts
This commit is contained in:
1 parent
f858f10ce2
commit
ed8302bc6b
7 files changed
+81
-28
No files matched your search
@@ -8,20 +8,19 @@ Typescript parts are in app/. Java parts are in App_Resources/Android/src/main/j
|
||||
wear/ is a separate Gradle project (Kotlin + Compose for Wear OS): the watch
|
||||
remote that drives Faceclaw over the Wearable Data Layer. Its phone-side
|
||||
counterparts are FaceclawWearBridge.java, app/native/wear-bridge.ts and
|
||||
app/g2/wear-remote.ts; the message format is in wear/PROTOCOL.md. Build it
|
||||
with `cd wear && ./gradlew :app:assembleDebug` (needs JAVA_HOME and
|
||||
ANDROID_HOME); it is not part of `npm run build`.
|
||||
app/g2/wear-remote.ts; the message format is in wear/PROTOCOL.md.
|
||||
|
||||
If build.sh exists, it's a machine-specific wrapper that sets some environment
|
||||
variables to point to where tools are installed, then runs `npm run build`.
|
||||
If build_and_run.sh exists, it does everything build.sh does plus
|
||||
`nativescript run android --device <id> --justlaunch`,
|
||||
which will launch the app on the developer's phone if it is plugged in and has
|
||||
adb enabled. If no phone is connected, it will still build but the install step
|
||||
will fail and the output will contain the string "Cannot find connected
|
||||
devices." To lint and typecheck, prefer to use build.sh; if the user asks you
|
||||
to run or test the app, use build_and_run.sh and then use `adb logcat` to view
|
||||
the results.
|
||||
`build.sh` and `build_wear.sh` build the Android and Wear OS apps respectively.
|
||||
`build_and_run.sh` builds the Android app then also installs it on a phone
|
||||
paired with `adb`. Building may require configuring environment variables
|
||||
(JAVA_HOME, ANDROID_HOME, PATH, ANDROID_KEYSTORE, ANDROID_KEYSTORE) to point at
|
||||
relevant tools and an Android device ID to install on; do this in
|
||||
build_paths.sh, which is created from build_paths.sh.template and not checked
|
||||
into git.
|
||||
|
||||
To lint and typecheck, prefer to use build.sh; if the user asks you to run or
|
||||
test the app, use build_and_run.sh and then use `adb logcat` to view the
|
||||
results.
|
||||
|
||||
If you are working on low-level communication bits, consider checking out
|
||||
https://github.com/Commute773/g2-kit-unofficial/ and referring to ble/docs/
|
||||
@@ -30,4 +29,10 @@ well as some communication test scripts and documentation of caveats that
|
||||
come up when communicating with the headset. There may already be an existing
|
||||
local checkout above this workspace at ../g2-kit-unofficial.
|
||||
|
||||
This Android app uses a modded firmware for the G2 smart glasses. Source code
|
||||
to the corresponding firmware modifications lives in
|
||||
https://github.com/jimrandomh/g2flash; there is a compiled version of the
|
||||
firmware patch-set in app/g2/firmware/cfw-patches.ts. Strongly prefer making
|
||||
changes to the Android app over making changes to changes to the firmware, as
|
||||
firmware development is considerably more fraught.
|
||||
|
||||
Reference in new issue
Block a user