[mobile] Further README updates

README.md

@@ -2,8 +2,12 @@
 
 A cross-platform version of BloomReader (with reduced feature set)
 
-Not a monorepo right now because of lots of pain getting all the dependencies to work right (both when fully hoisted and with some nohoist). Just having separate things inside the same repo.
+Not a monorepo right now because of lots of pain getting all the dependencies to work right (both when fully hoisted and with some nohoist). Just having separate packages co-existing inside the same repo.
 
-##
+# Getting Started
 
-Right now, I recommend opening packages/mobile and packages/web in separate VSCode windows. I think it makes it easier to keep straight what you're working on that way. But it's up to you.
+[PLEASE CLICK HERE ](https://github.com/BloomBooks/BloomReader-Lite/blob/master/packages/mobile/README.md) to read the mobile package's README for detailed instructions on getting started
+
+### Environment Setup
+
+You can either open one VSCode window to edit all the packages, or you can open up one VSCode window per package. It's up to you.

packages/mobile/README.md

@@ -25,9 +25,9 @@ BloomReaderLite requires custom native code, so you cannot use the default Expo
 -   Look for a "developer" channel build, either from the ["Local Build"](https://github.com/BloomBooks/BloomReader-Lite/actions/workflows/build-local.yml) Github action workflow or the Expo cloud builds.
 -   If one doesn't exist yet, you can generate a "developer" build using a variety of methods ways. Any of them are fine.
     -   Go to the ["Local Build"](https://github.com/BloomBooks/BloomReader-Lite/actions/workflows/build-local.yml) Github action workflow, then click "Run workflow" and start a "developer" channel build. Look in the artifacts, download the one for the desired platform, and unzip it to get the APK or IPA file.
-    -   Run the "Cloud Build" github action workflow, then look in our expo.dev account for the build (uses Expo quota).
-    -   On your development machine, run `yarn eas:build:android` or `yarn eas:build:ios` (or equivalently, `eas build --platform [android|ios] --profile developer`), then look in our expo.dev account for the build (uses Expo quota).
-    -   You could build it locally using `eas build --platform [android|ios] --profile developer --local`. However, Android builds only work on Linux or MacOS, and iOS builds only work on MacOS.
+    -   Run the "Cloud Build" github action workflow, then look in our expo.dev account for the build (uses [Expo quota](https://expo.dev/pricing)).
+    -   On your development machine, run `yarn eas:build:android` or `yarn eas:build:ios` (or equivalently, `yarn eas build --platform [android|ios] --profile developer`), then look in our expo.dev account for the build (uses [Expo quota](https://expo.dev/pricing)).
+    -   You could build it locally using `yarn eas build --platform [android|ios] --profile developer --local`. However, Android builds only work on Linux or MacOS, and iOS builds only work on MacOS.
 
 ### 2: Transfer to phone
 
@@ -78,6 +78,7 @@ Note: if you change the file structure in [mobile], hot reloading might not work
 -   Error in network response: Ensure network settings correct (see "Modify Network Setup" in Initial Setup)
 -   "Cannot connect to Metro": It times out really quickly. Reload the app on your phone.
 -   See if clearing the cache will help. `yarn start --clear`. For further cache clearing, refer to [this guide](https://docs.expo.dev/troubleshooting/clear-cache-windows/)
+-   Try Android Studio's "Logcat" if you have issues on the Android app (especially on non-development builds) that you can't debug from Javascript. Open up Android Studio, connect the Android device via cable or use an emulator, View -> Tool Windows -> Logcat
 
 ## Debugging bloom-player
 
@@ -88,21 +89,29 @@ Note: if you change the file structure in [mobile], hot reloading might not work
 -   Edit this file (bloomPlayerMin.jsAsset) as needed for debugging purposes.
 -   Reload the app every time this file changes.
 -   Note: If you manually copied the bloomPlayer file and the "copy:webDist" script in package.json runs, you will need to rerun these steps.
+-   Alternatively, you can copy the modified bloom-player at the [web] package level instead of in the [mobile] package
 
 ## Creating new custom build
 
 -   It's only necessary to do a new custom build if new native code is added
     -   This includes both installing packages that have native Android code or native iOS code, as well as if you write your own custom native module.
 -   Otherwise, just doing `yarn start` from your dev machine is sufficient to deliver simpler changes like Typescript code changes or adding a new JS-only module.
+-   Precondition: If not already logged in, run `yarn expo login`
 -   Android:
-    -   Run "eas build --profile development --platform android"
+    -   Run `yarn eas build --profile development --platform android`
 -   iOS
-    -   Run "eas device:create"
-    -   Send the QR code or link to any iOS devices you want to be able to access this. On the device, open the QR code/link, download the profile, then install the profile. (https://docs.expo.dev/build/internal-distribution/#22-configure-app-signing-credentials-for-ios)
-    -   "eas build --profile development --platform ios"
+    -   Run `yarn eas build --profile development --platform ios`
+    -   You can probably get by without an Apple Developer account if nothing needs to change. When it prompts you if you want to login, you can select "no". Assuming no new iOS devices have been registered to be allowed to use the internal distribution build, then the next question will be "All your registered devices are present in the Provisioning Profile. Would you like to reuse the profile?" You can select "yes" for that. If not, you most likely want to add the newly registered devices to the provisioning profile. Follow the prompts for that.
 -   You can also substitute "--platform all" to build both at once. (FYI, this will be billed as 2 builds, not 1)
 -   Further Reading: https://docs.expo.dev/development/create-development-builds/
 
+## Credentials needed
+
+-   An Expo user account. Get added to the "BloomBooks" Expo organization by an administrator.
+-   Optional: Apple developer account
+    -   There is a SIL organization one. Chris Hubbard is the administrator for that. Ask him if you need one.
+    -   It is needed for registering more iOS devices.
+
 ## Other Topics
 
 ## iOS Internal Distribution
@@ -111,7 +120,13 @@ This is only necessary for iOS internal distribution builds (cases when eas.json
 
 Internal distribution builds only work on devices whose device ID (UDID) is specified in the provisioning profile.
 
--   Run "eas device:create"
+To register a new device, have the owner of that device visit an Expo register-device link on their computer or iPhone. Here is a link generated for this repo: https://expo.dev/register-device/5105d727-c870-456d-9b68-cecfea115d60
+
+If you need to generate a new link:
+
+-   Precondition: You will need to have an Apple Developer account you can sign in to.
+-   Run `yarn eas device:create`
+-   You'll be prompted to login to your Apple Developer account if you aren't already.
 -   Send the QR code or link to any iOS devices you want to be able to access this. On the device, open the QR code/link, download the profile, then install the profile. (https://docs.expo.dev/build/internal-distribution/#22-configure-app-signing-credentials-for-ios)
 -   See [instructions to re-sign a build](https://github.com/expo/eas-cli#eas-buildresign) (or do a full re-build).
     -   I recommend running this in interactive mode (i.e. --non-interactive flag omitted), AKA try running this on a dev machine.
@@ -127,10 +142,10 @@ Each unique package identifier needs it own keystores/credentials.
 
 If you need to generate new keystores or credentials... well, you can't do it in non-interactive mode on the Github action runner. So you should do that from your local machine.
 
-You can generate the Android keystores by running `eas build --local --platform android --profile {desiredProfile}`.
+You can generate the Android keystores by running `yarn eas build --local --platform android --profile {desiredProfile}`.
 If you're on a Windows machine, it'll let you enter the keystore dialog and then it'll fail when it starts building (because only Linux + Mac are supported). Even though it doesn't finish building, the keystore will still be generated and you're good to go.
 
-For iOS, if you're on a windows machine, you can start a cloud build (`eas build -platform ios --profile {desiredProfile}`), fill out the dialogs, and then when it starts uploading your build to the cloud, you can cancel it. It'll still save the credential information and now your non-interactive builds on the Github action runner will be able to pick up the information.
+For iOS, if you're on a windows machine, you can start a cloud build (`yarn eas build -platform ios --profile {desiredProfile}`), fill out the dialogs, and then when it starts uploading your build to the cloud, you can cancel it. It'll still save the credential information and now your non-interactive builds on the Github action runner will be able to pick up the information.
 
 ### Possibly Deprecated Development Notes