From 5515958231f239b5c94fa66a8b3ff3e1d2a84eff Mon Sep 17 00:00:00 2001 From: pynicolas <6371790+pynicolas@users.noreply.github.com> Date: Tue, 16 Sep 2025 09:00:26 +0200 Subject: [PATCH] README: add note on the segmentation model --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 320622f..791660c 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ See also the website: [fairscan.org](https://fairscan.org) ## Features -- Automatic document detection (using a custom image segmentation model) +- Automatic document detection (using a [custom image segmentation model](https://github.com/pynicolas/fairscan-segmentation-model)) - Automatic perspective correction - Automatic image enhancement @@ -50,7 +50,7 @@ FairScan should be compatible with all devices that: Kudos to the developers of those projects! -## Build instructions +## Build To build an APK: ```bash @@ -62,5 +62,10 @@ To build an Android App Bundle: ./gradlew clean check :app:bundleRelease ``` +### Note on the segmentation model +The builds automatically downloads the segmentation model from +[fairscan-segmentation-model](https://github.com/pynicolas/fairscan-segmentation-model). +This is done in [`download-tflite.gradle.kts`](app/download-tflite.gradle.kts). + ## License This project is licensed under the GNU GPLv3. See [LICENSE](LICENSE) for details.