aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJason A. Donenfeld <Jason@zx2c4.com>2019-10-13 20:00:26 +0200
committerJason A. Donenfeld <Jason@zx2c4.com>2019-10-14 13:03:10 +0200
commite3f0f43bb81119eafeb04b66cb7deacd5c1db743 (patch)
tree3141511288cc86bcf6b16eed3a28ba1590513555 /README.md
downloadandroid-wireguard-module-builder-e3f0f43bb81119eafeb04b66cb7deacd5c1db743.tar.xz
android-wireguard-module-builder-e3f0f43bb81119eafeb04b66cb7deacd5c1db743.zip
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..53f3604
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+## Android WireGuard Module Builder
+
+This builds [WireGuard](https://www.wireguard.com/) modules for various Android kernels.
+
+### Adding your phone's kernel
+
+1. Create a directory in `kernels/` if it doesn't already exist.
+
+2. Add a corresponding `manifest.xml`, with versions based on stable non-moving tags and refs.
+
+3. Add a `do.bash` with minimal commands for conducting the build.
+
+4. Add a `version-hashes.txt` containing the output of `printf '%s|%s\n' "$(sha256sum < /proc/version | cut -d ' ' -f 1)" "$(cat /proc/version)"` from your phone.
+
+Note that if a kernel directory already exists that is compatible (i.e. the module loads and works) with your phone's kernel, simply skip to step 4 and append the line.
+
+### Building
+
+Build all kernels:
+
+```
+$ ./build-all.bash
+```
+
+Build just one:
+
+```
+$ ./build-one.bash crosshatch
+```
+
+### Downloading
+
+These are built, signed, and uploaded to [the WireGuard download server](https://download.wireguard.com/android-module/). They can automatically be used by the [WireGuard app](https://play.google.com/store/apps/details?id=com.wireguard.android):
+
+![Early debug alpha of WireGuard app downloading and inserting kernel module](https://data.zx2c4.com/wireguard-android-download-load-module-oct-13-2019.gif)