@@ -7,34 +7,58 @@ FairScan is an Android app to scan documents. It aims to be simple and respectfu
77- The scanning process should be obvious.
88- The app should automatically handle all image processing and PDF generation tasks.
99
10- [ ![ Google Play]] [ https://play.google.com/store/apps/details?id=org.fairscan.app ]
11- [ ![ GitHub releases]] [ releases ]
12- [ ![ fairscan.org]] [ https://fairscan.org ]
10+ [ Google Play] ( https://play.google.com/store/apps/details?id=org.fairscan.app )
11+ [ GitHub releases] ( releases )
12+ [ fairscan.org] ( https://fairscan.org )
1313
1414<p >
15- <img src =" screenshots/step-1.webp " width =" 30% " style = " margin : 1 % " >
16- <img src =" screenshots/step-2.webp " width =" 30% " style = " margin : 1 % " >
17- <img src =" screenshots/step-3.webp " width =" 30% " style = " margin : 1 % " >
15+ <img src =" screenshots/step-1.webp " width =" 30% " >
16+ <img src =" screenshots/step-2.webp " width =" 30% " >
17+ <img src =" screenshots/step-3.webp " width =" 30% " >
1818</p >
1919
2020## Features
2121
22- - Capture from the device camera
23- - Automatic document detection using segmentation
24- - Perspective correction
25- - PDF export
26- - 100% offline, no ads, no tracking, no account
22+ - Automatic document detection (using a custom image segmentation model)
23+ - Automatic perspective correction
24+ - Automatic image enhancement
2725
28- ## Philosophy
26+ ## Compatibility
2927
30- Most document scanner apps are cluttered, invasive, or frustrating to use.
31- FairScan aims to be a simple, efficient and respectful alternative.
28+ FairScan should be compatible with all devices that:
29+ - run Android 8.0 or a more recent version
30+ - have a camera
3231
32+ ## Privacy
33+
34+ - All data stay on the device. As of today, FairScan doesn't use any access to internet.
35+ - Minimal permissions:
36+ - Camera
37+ - WRITE_EXTERNAL_STORAGE: only on Android 8 and 9 to save generated PDFs in the Download directory.
38+ - Zero trackers.
39+
40+ ## Main dependencies
41+
42+ - Jetpack Compose for the user interface
43+ - CameraX to capture images from the camera
44+ - LiteRT to run the segmentation model for automatic document detection
45+ - OpenCV for:
46+ - perspective correction
47+ - image enhancement
48+ - PDFBox for PDF generation
49+
50+ Kudos to the developers of those projects!
3351
3452## Build instructions
3553
54+ To build an APK:
55+ ``` bash
56+ ./gradlew clean check assembleRelease
57+ ```
58+
59+ To build an Android App Bundle:
3660``` bash
37- ./gradlew assembleRelease
61+ ` ./gradlew clean check :app:bundleRelease
3862` ` `
3963
4064# # License
0 commit comments