Skip to content

Commit 8171a4a

Browse files
authored
Updates to FAQ (#339)
* FAQ enhancements, by @jensli
1 parent 00656ba commit 8171a4a

File tree

2 files changed

+46
-19
lines changed

2 files changed

+46
-19
lines changed

FAQ.md

Lines changed: 40 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,62 @@
1-
**Q**. What is OpenNoteScanner?
1+
**Q**: What is OpenNoteScanner?
22

3-
**A**. OpenNoteScanner is a mobile application which provides users with a simple and easy way of scanning their handwritten notes and also printed documents.
3+
**A**: OpenNoteScanner is a mobile application which provides users with a simple and easy way of scanning their handwritten notes and also printed documents.
44

5-
**Q**. What is OpenCV Manager?
5+
**Q**: What is OpenCV Manager?
66

7-
**A**. OpenCV means **Open Source Computer Vision Library**, This library is used by OpenNoteScanner to enhance images, track, object recognition and detection and panorama stitching.
7+
**A**: OpenCV means **Open Source Computer Vision Library**, This library is used by OpenNoteScanner to enhance images, track, object recognition and detection and panorama stitching.
88
OpenCV is licensed under (3- clause BSD) for educational and commercial use.
99

10-
**Q**. How do I scan documents with OpenNoteScanner?
10+
**Q**: How do I scan documents with OpenNoteScanner?
1111

12-
**A**. Place your phone over the document to be scanned, Click the **camera icon** at the base of the app, once to scan the document and click again to capture the scanned document.
12+
**A**: These are the steps to scan a document:
1313

14-
**Q**. Where do I find my captured documents?
14+
1. Place your phone over the document to be scanned and point the camera at the document.
15+
2. Point the camera so that all of the four corner markers on the screen is placed inside the document.
16+
3. Click the **camera icon** at the base of the app.
17+
4. The app will try to detect the document. When the document is detected the app will show an outline around it on the camera screen and a photo will be taken.
18+
5. Click on the **Image icon** at the top right corner of the screen to view your scanned documents.
1519

16-
**A**. Click on the **Image icon** at the top right corner of the screen, here you can view your scanned documents from the app.
20+
**Q**: Why doesn't the app detect my document? I point the camera at the document and press the trigger button but nothing happens.
1721

18-
**Q**. Where are the captured documents stored on my device?
22+
**A**: Here are a few things that might be wrong:
1923

20-
**A**. They are stored by default in your device internal storage memory under the folder named **OpenNoteScanner**.
24+
* You might have activated Automatic Mode. In Automatic Mode the document must contain a custom QR code that triggers detection. Switch to Manual Mode by pressing the **Automatic Mode icon** in the toolbar.
2125

22-
**Q**. Can I change the default folder?
26+
* Make sure that the contrast between the document and the background is high enough. For example, if the page color is white then the background should be as dark as possible.
2327

24-
**A**. Yes, by clicking the **horizontal broken lines** at the top of the screen. click the **settings icon**, scroll down to the section (storage folder), select it and input the name of your preferred folder and click **ok**
28+
* Try to scan with the camera flash activated for better lighting. Activate the flash by tapping the **flash icon** in the toolbar.
2529

26-
**Q**. Can storage location be changed from device internal storage to **SD Card**?
30+
* Make sure that all of the four corner markers on the camera screen is placed inside the document.
2731

28-
**A**. Unfortunately **No**, storage location is set at device internal storage.
32+
**Q**: Where do I find my captured documents?
2933

30-
**Q**. My captured documents are in black and white, I need some color?
34+
**A**: Click on the **Image icon** at the top right corner of the screen, here you can view your scanned documents from the app.
3135

32-
**A**. Click the **horizontal broken lines** at the top of the screen, and click the color platelet icon and the menu tray to activate color mode, click the platelet again to get back the default black and white mode.
36+
**Q**: Where are the captured documents stored on my device?
3337

34-
**Q**. I am in a dark place and need to capture a document?
38+
**A**: They are stored by default in your device internal storage memory under the folder named **OpenNoteScanner**:
3539

36-
**A**. You can activate the flash light mode by clicking the **horizontal broken lines** at the top of the screen, and click the flash light icon on the menu tray. This activates the flash light of your device camera to enable visible capturing of the documents.
40+
**Q**: Can I change the default folder?
41+
42+
**A**: Yes, by clicking the **horizontal broken lines** at the top of the screen. click the **settings icon**, scroll down to the section (storage folder), select it and input the name of your preferred folder and click **ok**
43+
44+
**Q**: Can storage location be changed from device internal storage to **SD Card**?
45+
46+
**A**: Unfortunately **No**, storage location is set at device internal storage.
47+
48+
**Q**: My captured documents are in black and white, I need some color?
49+
50+
**A**: Click the **horizontal broken lines** at the top of the screen, and click the color platelet icon and the menu tray to activate color mode, click the platelet again to get back the default black and white mode.
51+
52+
**Q**: I am in a dark place and need to capture a document?
53+
54+
**A**: You can activate the flash light mode by clicking the **horizontal broken lines** at the top of the screen, and click the flash light icon on the menu tray. This activates the flash light of your device camera to enable visible capturing of the documents.
55+
56+
**Q**: How can I contact the maintainers?
57+
58+
**A**: To contact us, please click on the **horizontal broken lines** at the top of the screen, and select **settings icon** from the menu tray, scroll down to **feedback and suggestions** and select any of the communication channel listed.
3759

38-
To contact us, please click on the **horizontal broken lines** at the top of the screen, and select **settings icon** from the menu tray, scroll down to **feedback and suggestions** and select any of the communication channel listed.
3960
* Via GitHub.
4061
* Via Telegram.
4162
* Via Email.

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ After the page is detected, it compensates any perspective from the image adjust
1313

1414
It is also possible to launch the application from any other application that asks for a picture, just make sure that there is no default application associated with this action.
1515

16+
Usage
17+
-----
18+
19+
See the [FAQ](FAQ.md).
20+
21+
1622
Screenshots
1723
-----------
1824

0 commit comments

Comments
 (0)