From 58afe2e0eff5131f65b9bbfa381963b1d33e995e Mon Sep 17 00:00:00 2001 From: Enginex0 Date: Wed, 11 Mar 2026 00:28:28 +0100 Subject: [PATCH] docs(readme): add build badge and building-from-source section --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 97701f9..2a042c1 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,8 @@

Full TEE Emulation for Rooted Android

Hardware attestation. Software keys. Zero detection.

- v4.0 + Build + v4.2 Android 10+ Telegram

@@ -112,6 +113,24 @@ TEESimulator replaces TrickyStore, TrickyStoreOSS, and their forks. Existing con --- +## 🔨 Building from Source + +The CI workflow builds on every push to `main`. You can also build locally or trigger a build from your own fork. + +**Prerequisites:** JDK 21, Android SDK/NDK 27, Rust stable with `aarch64-linux-android` target, `cargo-ndk`. + +```bash +git clone https://github.com/Enginex0/TEESimulator.git +cd TEESimulator +./gradlew zipRelease zipDebug +``` + +Output ZIPs land in `out/`. The Gradle build automatically invokes `cargo ndk` to cross-compile `libcertgen.so` before packaging. + +To rebuild from a fork, push to `main` or use **Actions → Build → Run workflow**. The workflow installs all toolchains (Java, Rust, cargo-ndk, ccache) and uploads Release + Debug ZIPs as artifacts. + +--- + ## ⚙️ Configuration All configuration files live at `/data/adb/tricky_store/` and are monitored by `FileObserver` — changes take effect immediately without rebooting.