From b2d4f4d46d4e3ad31c0709a6e6975529a30094cd Mon Sep 17 00:00:00 2001 From: Seshan Ravikumar Date: Thu, 23 Feb 2023 13:14:53 -0500 Subject: [PATCH] Update README --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0b770bc..dca32de 100755 --- a/README.md +++ b/README.md @@ -3,10 +3,22 @@ Nightly Alpine packages for Plasma Mobile from master/main and postmarketOS imag [The Images build script can be found here.](https://github.com/Sineware/plasma-mobile-nightly-img) -### Environment Variables +### Environment Variables (optional) - BUILD_SINGLE_PACKAGE = string: (build a single package from repo.ts) - BUILD_SINGLE_PACKAGE_BRANCH = string: (select a branch from the git repo) - BUILD_SINGLE_PACKAGE_REPO = string: (set a alternative repo url) - PACKAGE_LIST = string,string,string...: (build the list of packages) - IGNORE_GIT_SILENT = true/false: (build packages even if the last commit was GIT_SILENT) -- DISTCC_SETTINGS = true/false: (build packages using distcc env) \ No newline at end of file +- DISTCC_SETTINGS = true/false: (build packages using distcc env) + +### Running +Make sure to have run `sudo apk add alpine-sdk ccache` (to have a compiler), `sudo addgroup user abuild` (to be able to run abuild), and `abuild-keygen -a -i` (to generate a key for signing a package). Relog to update groups. + +It can be convenient to have passwordless sudo enabled. + +Start the script: `npm run build` + +### Example Command: Building plasma-mobile only with a specific branch +```sh +BUILD_SINGLE_PACKAGE=plasma-mobile BUILD_SINGLE_PACKAGE_BRANCH=work/kwintaskswitcher npm run build +``` \ No newline at end of file