From 685e1b65b718f04f224945514ade63c43743da0e Mon Sep 17 00:00:00 2001 From: Jack Greenlee Date: Wed, 18 Oct 2023 00:33:28 -0400 Subject: [PATCH] Update README.md Reword the "Building the app" section to make it clearer what scripts are available and what they do --- README.md | 25 ++++++++++--------------- 1 file changed, 10 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 28f6fe615..9e3b865c0 100644 --- a/README.md +++ b/README.md @@ -205,22 +205,17 @@ If connecting to a development server over http, make sure to turn on http suppo ### Building the app -``` -npm run -``` -AND/OR -``` -npm run -``` -For other options of build scripts, refer to [`package.cordovabuild.json`](package.cordovabuild.json) -Common ones listed below (both, Android, iOS) -``` -npm run build -npm run build-prod-android -npm run build-prod-ios -``` +We offer a set of build scripts you can pick from, each of which i) bundle the JS with Webpack and then ii) proceed with a Cordova build. +You can bundle JS in 'production' or 'dev' mode, and you can build Android or iOS or both. +The common use cases will be: + +- `npm run build` (to build for production on both Android and iOS platforms) +- `npm run build-prod-android` (to build for production on Android platform only) +- `npm run build-prod-ios` (to build for production on iOS platform only) + +Find the full list of these scripts in [`package.cordovabuild.json`](package.cordovabuild.json) -
Expected output +
Expected output (Android build) ``` BUILD SUCCESSFUL in 2m 48s