nico/kobopatch-webui
1
0
Fork 0
Code Actions Activity

Update README
All checks were successful
Build and test project / build-and-test (push) Successful in 1m57s
Details

Browse Source
This commit is contained in:
Nico Verbruggen
2026-03-19 22:35:25 +01:00
parent 0204d9263a
commit 7b2047563a
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -47,12 +47,13 @@ web/
patch-ui.js # PatchUI: loads patches, parses YAML, renders toggle UI patch-ui.js # PatchUI: loads patches, parses YAML, renders toggle UI
patch-runner.js # KoboPatchRunner: spawns Web Worker per build patch-runner.js # KoboPatchRunner: spawns Web Worker per build
patch-worker.js # Web Worker: loads WASM, runs patchFirmware() patch-worker.js # Web Worker: loads WASM, runs patchFirmware()
strings.js # Localized UI strings
wasm_exec.js # Go WASM runtime (copied from Go SDK by build.sh, gitignored) wasm_exec.js # Go WASM runtime (copied from Go SDK by build.sh, gitignored)
patches/ patches/
index.json # Available patch manifest index.json # Available patch manifest
downloads.json # Firmware download URLs by version/serial (may be auto-generated) downloads.json # Firmware download URLs by version/serial (may be auto-generated)
patches_*.zip # Patch files per firmware version patches_*.zip # Patch files per firmware version
nickelmenu/ # NickelMenu assets (generated by setup.sh, gitignored) nickelmenu/ # NickelMenu assets (generated by nickelmenu/setup.sh, gitignored)
NickelMenu.zip NickelMenu.zip
kobo-config.zip kobo-config.zip
favicon/ favicon/
@@ -68,7 +69,7 @@ nickelmenu/
kobopatch-wasm/ kobopatch-wasm/
main.go # Go entry point main.go # Go entry point
go.mod go.mod go.sum
setup.sh # Clones kobopatch source, copies wasm_exec.js setup.sh # Clones kobopatch source, copies wasm_exec.js
build.sh # Compiles WASM, copies to web/dist/wasm/ and web/src/js/ build.sh # Compiles WASM, copies to web/dist/wasm/ and web/src/js/
integration_test.go integration_test.go
@@ -79,6 +80,10 @@ tests/
integration.spec.js # Playwright E2E tests integration.spec.js # Playwright E2E tests
playwright.config.js playwright.config.js
run-e2e.sh run-e2e.sh
# Root scripts
test.sh # Runs all tests (WASM + E2E)
serve-locally.sh # Serves app at localhost:8888
``` ```
## Adding a new software version ## Adding a new software version