From 6c3f15ca84a854b8da209f8fd88236882cb7754c Mon Sep 17 00:00:00 2001 From: sneurlax Date: Tue, 25 Jun 2024 14:34:09 -0500 Subject: [PATCH] add build_app.sh docs --- docs/building.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/building.md b/docs/building.md index 79e1bfb64..3d35acea2 100644 --- a/docs/building.md +++ b/docs/building.md @@ -116,6 +116,22 @@ cd .. or manually by creating the files referenced in that script with the specified content. ### Build plugins +#### Build script: `build_app.sh` +The `build_app.sh` script is use to build applications Stack Wallet. View the script's help message with `./build_app.sh -h` for more information on its usage. + +Options: + + - `a `: Specify the application ID (required). Valid options are `stack_wallet` or `stack_duo`. + - `b `: Specify the build number in 123 (required). + - `p `: Specify the platform to build for (required). Valid options are `android`, `ios`, `macos`, `linux`, or `windows`. + - `v `: Specify the version of the application in 1.2.3 format (required). + - `i`: Optional flag to skip building crypto plugins. Useful for updating `pubspec.yaml` and white-labelling different apps with the same plugins. + +For example, +``` +./build_app.sh -a stack_wallet -p linux -v 2.1.0 -b 210 +``` + #### Building plugins for Android > Warning: This will take a long time, please be patient ```