@@ -78,7 +78,7 @@ The kernel has the following features:
7878
7979## Usage
8080
81- The custom build wrapper (aka "builder ") consists of 2 core components and 3 primary commands:
81+ The custom build wrapper (aka "zkb ") consists of 2 core components and 3 primary commands:
8282
8383Components:
8484
@@ -92,8 +92,8 @@ Commands:
9292- ` bundle ` .
9393
9494``` help
95- $ python3 builder --help
96- usage: builder [-h] [--clean] {kernel,assets,bundle} ...
95+ $ python3 zkb --help
96+ usage: zkb [-h] [--clean] {kernel,assets,bundle} ...
9797
9898A custom builder for the zero_kernel.
9999
@@ -124,7 +124,7 @@ To run this tool in a `local` environment, you will need:
124124``` sh
125125# install uv version from project file
126126python3 -m pip install -r requirement-uv.txt
127- # make builder / internal imports visible to itself
127+ # make zkb / internal imports visible to itself
128128export PYTHONPATH=$( pwd)
129129# prepare and activate dev environment
130130uv sync --frozen --no-install-project
@@ -138,8 +138,8 @@ Once you are finished working with the project, don't forget to disable the virt
138138Kernel build process can be launched using the ` kernel ` subcommand.
139139
140140``` help
141- $ python3 builder kernel --help
142- usage: builder kernel [-h] --build-env {local,docker,podman} --base {los,pa,x,aosp}
141+ $ python3 zkb kernel --help
142+ usage: zkb kernel [-h] --build-env {local,docker,podman} --base {los,pa,x,aosp}
143143 --codename CODENAME --lkv LKV [-c] [--clean-image] [--ksu]
144144
145145options:
@@ -161,8 +161,8 @@ options:
161161As mentioned, there is also an asset downloader, which can collect latest versions of ROM, TWRP, Magisk and it's modules, Kali Chroot etc.
162162
163163``` help
164- $ python3 builder assets --help
165- usage: builder assets [-h] --build-env {local,docker,podman} --base {los,pa,x,aosp}
164+ $ python3 zkb assets --help
165+ usage: zkb assets [-h] --build-env {local,docker,podman} --base {los,pa,x,aosp}
166166 --codename CODENAME --chroot {full,minimal} [--rom-only]
167167 [--clean-image] [--clean] [--ksu]
168168
@@ -203,8 +203,8 @@ Options `full` and `conan` collect all of the assets required to successfuly fla
203203Option named ` slim ` is a much lighter version of ` full ` packaging, as only the ROM is collected from the asset list. This is done to reduce package sizes while ensuring the kernel+ROM compatibility.
204204
205205``` help
206- $ python3 builder bundle --help
207- usage: builder bundle [-h] --build-env {local,docker,podman} --base {los,pa,x,aosp}
206+ $ python3 zkb bundle --help
207+ usage: zkb bundle [-h] --build-env {local,docker,podman} --base {los,pa,x,aosp}
208208 --codename CODENAME --lkv LKV --package-type
209209 {conan,slim,full} [--conan-upload] [--clean-image] [--ksu]
210210
@@ -231,19 +231,19 @@ Here are some examples of commands:
231231** (Recommended)** Build kernel and collect ROM via Docker:
232232
233233``` sh
234- python3 builder bundle --build-env=docker --base=los --codename=dumpling --lkv=4.4 --package-type=slim
234+ python3 zkb bundle --build-env=docker --base=los --codename=dumpling --lkv=4.4 --package-type=slim
235235```
236236
237237Build kernel locally:
238238
239239``` sh
240- python3 builder kernel --build-env=local --base=los --codename=dumpling --lkv=4.4
240+ python3 zkb kernel --build-env=local --base=los --codename=dumpling --lkv=4.4
241241```
242242
243243Collect all of the assets locally:
244244
245245``` sh
246- python3 builder assets --build-env=local --base=los --codename=dumpling --package-type=full
246+ python3 zkb assets --build-env=local --base=los --codename=dumpling --package-type=full
247247```
248248
249249## See also
0 commit comments