Skip to content

Commit e011d8f

Browse files
emericgemericg
committed
Improve READMEs
1 parent 904dca4 commit e011d8f

6 files changed

Lines changed: 49 additions & 47 deletions

File tree

‎.gitignore‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,3 @@ assets/macos/macos_signature.pri
3636
# Others
3737
stash/*
3838
.DS_Store
39-
40-
# WIP
41-
thirdparty/zint-qml-*
42-
thirdparty/zxing-cpp-*

‎CMakeLists.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ if(USE_ZXINGCPP)
169169
target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE ZXingQt)
170170
target_compile_definitions(${CMAKE_PROJECT_NAME} PRIVATE QMS_USE_ZXINGCPP)
171171
elseif(USE_QZXING)
172-
# build QZxing
172+
# build QZXing
173173
add_subdirectory(thirdparty/QZXing)
174174
target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE QZXing)
175175
target_compile_definitions(${CMAKE_PROJECT_NAME} PRIVATE QMS_USE_QZXING)
@@ -181,7 +181,7 @@ if(USE_ZINT)
181181
add_subdirectory(thirdparty/zint-qml)
182182
target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE zint)
183183

184-
# build ZintQml wrapper
184+
# build Zint QML wrapper
185185
add_subdirectory(thirdparty/zint-qml/wrappers/qml)
186186
target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE ZintQml)
187187
target_compile_definitions(${CMAKE_PROJECT_NAME} PRIVATE QMS_USE_ZINT)

‎README.md‎

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ QmlMobileScanner
77

88
QmlMobileScanner is a DEMO barcode & QR code scanner based on qzxing and zxing-cpp libraries to scan and generate barcodes, and zint to generate some extra formats.
99

10-
Qt 6.8+, Qt Multimedia (with ffmpeg backend) and CMake are needed.
11-
Qt 6.x "minor" versions are full of major breakages, it's just not feasible to support a matrix of different versions or build systems, sorry.
10+
Qt 6.8+, Qt Multimedia (with ffmpeg backend) and CMake are needed.
11+
Qt 6 major and minor versions are full of API and build breakages, it's just not feasible for me to support a matrix of different versions or build systems, sorry.
1212

1313
Available backends:
14-
- QZXing / v3.3.0 + Qt6 port + many patches
1514
- zxing-cpp / v3.0.2 + custom QML integration
15+
- QZXing / v3.3.0 + Qt6 port + many patches
1616
- zint / v2.16 + custom QML integration
1717

1818
> Works on Android and iOS!
@@ -35,48 +35,50 @@ Available backends:
3535
- [x] Barcodes history
3636

3737

38-
## Supported Formats (QZXing)
38+
## Supported Formats (zint)
3939

40-
[QZXing](https://github.com/ftylitak/qzxing/) is a Qt/QML wrapper library for the ZXing barcode image processing library.
40+
[zint](https://github.com/zint/zint/) is a barcode encoding library supporting over 50 symbologies including Code 128, Data Matrix, USPS OneCode, EAN-128, UPC/EAN, ITF, QR Code, Code 16k, PDF417, MicroPDF417, LOGMARS, Maxicode, GS1 DataBar, Aztec, Composite Symbols and more.
41+
42+
43+
## Supported Formats (zxing-cpp)
44+
45+
[zxing-cpp](https://github.com/zxing-cpp/zxing-cpp/) is an open-source, multi-format linear/matrix barcode image processing library implemented in C++.
4146

4247
| Linear / 1D barcodes | Matrix / 2D barcodes |
4348
| -------------------- | -------------------- |
4449
| UPC-A | QR Code |
45-
| UPC-E | Data Matrix |
46-
| EAN-8 | PDF 417 |
47-
| EAN-13 | Aztec (beta) |
48-
| Code 39 | |
49-
| Code 93 | |
50-
| Code 128 (GS1) | |
51-
| Codabar | |
50+
| UPC-E | Micro QR Code |
51+
| EAN-8 | rMQR Code |
52+
| EAN-13 | Aztec Code |
53+
| DataBar | Aztec Rune |
54+
| DataBar Expanded | Data Matrix |
55+
| DataBar Limited | PDF417 |
56+
| Code 39 | Compact PDF417 |
57+
| Code 93 | MicroPDF417 |
58+
| Code 128 (GS1) | MaxiCode (partial) |
59+
| Codabar | DX Film Edge |
5260
| ITF | |
5361

5462

55-
## Supported Formats (zxing-cpp)
63+
## Supported Formats (QZXing)
5664

57-
[zxing-cpp](https://github.com/zxing-cpp/zxing-cpp/) is an open-source, multi-format linear/matrix barcode image processing library implemented in C++.
65+
[QZXing](https://github.com/ftylitak/qzxing/) is a Qt/QML wrapper library for the ZXing barcode image processing library.
66+
67+
> QZXing still works fine, but is considered deprecated
5868
5969
| Linear / 1D barcodes | Matrix / 2D barcodes |
6070
| -------------------- | -------------------- |
6171
| UPC-A | QR Code |
62-
| UPC-E | Micro QR Code |
63-
| EAN-8 | Aztec |
64-
| EAN-13 | Aztec Runes |
65-
| DataBar | DataMatrix |
66-
| DataBar Expanded | PDF417 |
67-
| DataBar Limited | MaxiCode (partial) |
68-
| Code 39 | DX Film Edge |
72+
| UPC-E | Data Matrix |
73+
| EAN-8 | PDF417 |
74+
| EAN-13 | Aztec (beta) |
75+
| Code 39 | |
6976
| Code 93 | |
7077
| Code 128 (GS1) | |
7178
| Codabar | |
7279
| ITF | |
7380

7481

75-
## Supported Formats (zint)
76-
77-
[zint](https://github.com/zint/zint/) is a barcode encoding library supporting over 50 symbologies including Code 128, Data Matrix, USPS OneCode, EAN-128, UPC/EAN, ITF, QR Code, Code 16k, PDF417, MicroPDF417, LOGMARS, Maxicode, GS1 DataBar, Aztec, Composite Symbols and more.
78-
79-
8082
## Documentation
8183

8284
#### Dependencies

‎qml/ScreenAboutFormats.qml‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ Flickable {
6767
ListElement { type: "linear"; name: "Codabar"; decode: 1; encode: 0; }
6868
ListElement { type: "matrix"; name: "QR Code"; decode: 1; encode: 1; }
6969
ListElement { type: "matrix"; name: "Data Matrix"; decode: 1; encode: 0; }
70-
ListElement { type: "matrix"; name: "Aztec"; decode: 1; encode: 0; }
71-
ListElement { type: "matrix"; name: "PDF 417"; decode: 1; encode: 0; }
70+
ListElement { type: "matrix"; name: "Aztec Code"; decode: 2; encode: 0; }
71+
ListElement { type: "matrix"; name: "PDF417"; decode: 1; encode: 0; }
7272
}
7373
ListModel {
7474
id: zxingcpp
@@ -88,12 +88,16 @@ Flickable {
8888
ListElement { type: "linear"; name: "ITF"; decode: 1; encode: 1; }
8989
ListElement { type: "matrix"; name: "QR Code"; decode: 1; encode: 1; }
9090
ListElement { type: "matrix"; name: "Micro QR Code"; decode: 1; encode: 0; }
91-
ListElement { type: "matrix"; name: "Aztec"; decode: 1; encode: 1; }
92-
ListElement { type: "matrix"; name: "Aztec Runes"; decode: 1; encode: 0; }
91+
ListElement { type: "matrix"; name: "rMQR Code"; decode: 1; encode: 0; }
92+
ListElement { type: "matrix"; name: "Aztec Code"; decode: 1; encode: 1; }
93+
ListElement { type: "matrix"; name: "Aztec Rune"; decode: 1; encode: 1; }
9394
ListElement { type: "matrix"; name: "Data Matrix"; decode: 1; encode: 1; }
94-
ListElement { type: "matrix"; name: "DX Film Edge"; decode: 1; encode: 0; }
95-
ListElement { type: "matrix"; name: "PDF 417"; decode: 1; encode: 1; }
95+
ListElement { type: "matrix"; name: "PDF417"; decode: 1; encode: 1; }
96+
ListElement { type: "matrix"; name: "Micro PDF417"; decode: 1; encode: 0; }
97+
ListElement { type: "matrix"; name: "Compact PDF417"; decode: 1; encode: 1; }
98+
ListElement { type: "matrix"; name: "PDF417"; decode: 1; encode: 1; }
9699
ListElement { type: "matrix"; name: "MaxiCode"; decode: 2; encode: 0; }
100+
ListElement { type: "matrix"; name: "DX Film Edge"; decode: 1; encode: 0; }
97101
}
98102
ListModel {
99103
id: zint
@@ -137,7 +141,7 @@ Flickable {
137141
ListElement { type: "2d"; name: "Royal Mail 4-State Mailmark"; decode: 0; encode: 1; }
138142
ListElement { type: "2d"; name: "USPS OneCode (Intelligent Mail)"; decode: 0; encode: 1; }
139143
ListElement { type: "matrix"; name: "Aztec Code"; decode: 0; encode: 1; }
140-
ListElement { type: "matrix"; name: "Aztec Runes"; decode: 0; encode: 1; }
144+
ListElement { type: "matrix"; name: "Aztec Rune"; decode: 0; encode: 1; }
141145
ListElement { type: "matrix"; name: "Data Matrix ECC200"; decode: 0; encode: 1; }
142146
ListElement { type: "matrix"; name: "DotCode"; decode: 0; encode: 1; }
143147
ListElement { type: "matrix"; name: "Grid Matrix"; decode: 0; encode: 1; }

‎qml/ScreenBarcodeWriter.qml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -383,11 +383,11 @@ Loader {
383383

384384
// matrix
385385
ListElement { idx: 0; type: "2d"; txt: "QR Code"; format: "qrcode"; maxnum: 0; maxchar: 4296; maxbytes: 2953; ecc: 4; }
386-
ListElement { idx: 1; type: "2d"; txt: "µQrCode"; format: "microqrcode"; maxnum: 0; maxchar: 21; maxbytes: 256; ecc: 4; }
386+
ListElement { idx: 1; type: "2d"; txt: "µQR Code"; format: "microqrcode"; maxnum: 0; maxchar: 21; maxbytes: 256; ecc: 4; }
387387
ListElement { idx: 2; type: "2d"; txt: "rect. µQrCode"; format: "rmqr"; maxnum: 0; maxchar: 21; maxbytes: 256; ecc: 4; }
388388
ListElement { idx: 3; type: "2d"; txt: "Aztec Code"; format: "aztec"; maxnum: 0; maxchar: 3067; maxbytes: 3067; ecc: 8; }
389389
//ListElement { idx: 4; type: "2d"; txt: "Aztec Rune"; format: "aztecrune"; maxnum: 0; maxchar: 3067; maxbytes: 3067; ecc: 8; }
390-
ListElement { idx: 4; type: "2d"; txt: "DataMatrix"; format: "datamatrix"; maxnum: 0; maxchar: 2335; maxbytes: 1556; ecc: 0; }
390+
ListElement { idx: 4; type: "2d"; txt: "Data Matrix"; format: "datamatrix"; maxnum: 0; maxchar: 2335; maxbytes: 1556; ecc: 0; }
391391
ListElement { idx: 5; type: "2d"; txt: "PDF417"; format: "pdf417"; maxnum: 0; maxchar: 1850; maxbytes: 1108; ecc: 8; }
392392
ListElement { idx: 6; type: "2d"; txt: "µPDF417"; format: "micropdf417"; maxnum: 0; maxchar: 256; maxbytes: 1108; ecc: 8; }
393393
ListElement { idx: 7; type: "2d"; txt: "GridMatrix"; format: "gridmatrix"; maxnum: 0; maxchar: 2335; maxbytes: 1556; ecc: 0; }
@@ -409,7 +409,7 @@ Loader {
409409
ListElement { idx: 0; type: "2d"; txt: "QR Code"; format: "qrcode"; maxchar: 4296; maxbytes: 2953; ecc: 4; }
410410
ListElement { idx: 1; type: "2d"; txt: "Aztec Code"; format: "aztec"; maxchar: 3067; maxbytes: 3067; ecc: 8; }
411411
//ListElement { idx: 2; type: "2d"; txt: "Aztec Rune"; format: "aztecrune"; maxchar: 3067; maxbytes: 3067; ecc: 8; }
412-
ListElement { idx: 2; type: "2d"; txt: "DataMatrix"; format: "datamatrix"; maxchar: 2335; maxbytes: 1556; ecc: 0; }
412+
ListElement { idx: 2; type: "2d"; txt: "Data Matrix"; format: "datamatrix"; maxchar: 2335; maxbytes: 1556; ecc: 0; }
413413
// linear
414414
ListElement { idx: 3; type: "1d"; txt: "Codabar"; format: "codabar"; maxnum: 12; }
415415
ListElement { idx: 4; type: "1d"; txt: "EAN 13"; format: "ean13"; maxnum: 12; }

‎qml/components/MenuFormats.qml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,20 +17,20 @@ Column {
1717
id: formatsAvailable_zxingcpp
1818
ListElement { txt: "Linear codes"; value: 51070; }
1919
ListElement { txt: "Aztec"; value: 1; }
20-
ListElement { txt: "DataMatrix"; value: 128; }
20+
ListElement { txt: "Data Matrix"; value: 128; }
2121
ListElement { txt: "MaxiCode"; value: 2048; }
2222
ListElement { txt: "PDF417"; value: 4096; }
23-
ListElement { txt: "QRCode"; value: 8192; }
24-
ListElement { txt: "µQRCode"; value: 65536; }
23+
ListElement { txt: "QR Code"; value: 8192; }
24+
ListElement { txt: "µQR Code"; value: 65536; }
2525
}
2626
ListModel {
2727
id: formatsAvailable_qzxing
2828
ListElement { txt: "Linear codes"; value: 517052; }
2929
ListElement { txt: "Aztec"; value: 2; }
30-
ListElement { txt: "DataMatrix"; value: 64; }
30+
ListElement { txt: "Data Matrix"; value: 64; }
3131
ListElement { txt: "MaxiCode"; value: 1024; }
3232
ListElement { txt: "PDF417"; value: 2048; }
33-
ListElement { txt: "QRCode"; value: 4096; }
33+
ListElement { txt: "QR Code"; value: 4096; }
3434
}
3535

3636
Repeater {

0 commit comments

Comments
 (0)