Skip to content

Commit cd0c488

Browse files
committed
[WIP] Revamp README.md
1 parent 5849cfc commit cd0c488

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,12 @@ 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+
## Get FairScan
11+
- [Google Play](https://play.google.com/store/apps/details?id=org.fairscan.app)
12+
- [GitHub releases](releases)
13+
- Website: [fairscan.org](https://fairscan.org)
1314

15+
## Screenshots
1416
<p>
1517
<img src="screenshots/step-1.webp" width="30%">
1618
<img src="screenshots/step-2.webp" width="30%">
@@ -39,13 +41,13 @@ FairScan should be compatible with all devices that:
3941

4042
## Main dependencies
4143

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:
44+
- [Jetpack Compose](https://developer.android.com/compose) for the user interface
45+
- [CameraX](https://developer.android.com/media/camera/camerax) to capture images from the camera
46+
- [LiteRT](https://ai.google.dev/edge/litert) to run the segmentation model for automatic document detection
47+
- [OpenCV](https://opencv.org/) for:
4648
- perspective correction
4749
- image enhancement
48-
- PDFBox for PDF generation
50+
- [PDFBox-Android](https://github.com/TomRoush/PdfBox-Android) for PDF generation
4951

5052
Kudos to the developers of those projects!
5153

0 commit comments

Comments
 (0)