README: add note on the segmentation model

This commit is contained in:
pynicolas
2025-09-16 09:00:26 +02:00
committed by GitHub
parent 4ad77dd700
commit 5515958231

View File

@@ -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.