From 0dc9f50ed2db137ccef97248686c337c9ad37f31 Mon Sep 17 00:00:00 2001 From: tiennm99 Date: Mon, 10 Aug 2026 15:36:39 +0700 Subject: [PATCH] docs: update run instructions after releases removal and merge Releases were removed, so point users at gradlew instead of jar downloads. Document the ngrok authtoken placeholder and the Windows-only native lib, and note the absorbed Python implementation reachable in history. --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c14ad4c..40bbbb7 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,21 @@ Just a QR code attendance demo app for my sister's representation, but written i ## How to run 1. Download java 21 from [here](https://www.oracle.com/java/technologies/downloads/#jdk21-windows) -2. Download the .jar file from the releases page -3. Run the .jar file with `java -jar .jar` +2. Set your ngrok authtoken in `src/main/resources/application.yml` (get one at + [dashboard.ngrok.com](https://dashboard.ngrok.com)), or disable the tunnel with + `ngrok.enabled: false` +3. Run with `gradlew bootRun`, or build a .jar with `gradlew build` and run it + with `java -jar build/libs/.jar` + +Note: the bundled ngrok native library is Windows x86_64 only; on other platforms +run with `ngrok.enabled: false`. + +## History + +This repository also holds the original Python (Flask + Excel) implementation +that this Java app replaced. Its files were removed in the "Clear and rewrite" +commit, but its full history is preserved — check out any commit before that +one to browse or run it. ## Note