Merge pull request #97 from yamt/readme-demo

README.md: mention requirements of each test/demo
This commit is contained in:
Alexandre Perrin 2021-03-28 20:59:30 +02:00 committed by GitHub
commit 7ef51ee6e7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -38,12 +38,16 @@ video stream is displayed on screen as it's received, and any QR codes
recognised are highlighted in the image, with the decoded information both
displayed on the image and printed on stdout.
This requires SDL and V4L2.
### quirc-scanner
This program turns your camera into a barcode scanner. It's almost the same as
the `demo` application, but it doesn't display the video stream, and thus
doesn't require a graphical display.
This requires V4L2.
### qrtest
This test is used to evaluate the performance of library. Given a directory
@ -57,6 +61,8 @@ This test is used for debugging. Given a single JPEG image, it will display a
diagram showing the internal state of the decoder as well as printing
additional information on stdout.
This requires SDL.
Installation
------------
To build the library and associated demos/tests, type `make`. If you need to