mirror of
https://gitee.com/openharmony/third_party_qrcodegen
synced 2024-11-27 01:11:45 +00:00
Updated the content of language-specific readme files and package-level documentation comments.
This commit is contained in:
Project Nayuki
parent
df44e259d1
commit
d02fe511cc
@ -1,15 +1,15 @@
|
||||
Fast QR Code generator library
|
||||
==============================
|
||||
QR Code generator library - Java, fast
|
||||
======================================
|
||||
|
||||
|
||||
Introduction
|
||||
------------
|
||||
|
||||
This Java library generates QR Code symbols, and its design is optimized for speed. It contrasts with another QR library by the same author which is slow but which optimizes for clarity and conciseness. The functionality of this library and its API are nearly identical to the slow library, but it runs anywhere from 1.5× to 10× as fast.
|
||||
This project aims to be the best, clearest QR Code generator library. The primary goals are flexible options and absolute correctness. Secondary goals are compact implementation size and good documentation comments.
|
||||
|
||||
Home page for the fast library (design explanation, benchmarks): [https://www.nayuki.io/page/fast-qr-code-generator-library](https://www.nayuki.io/page/fast-qr-code-generator-library)
|
||||
Home page for this fast library with design explanation and benchmarks: https://www.nayuki.io/page/fast-qr-code-generator-library
|
||||
|
||||
Home page for the slow library (live demo, QR Code introduction, competitor comparisons): [https://www.nayuki.io/page/qr-code-generator-library](https://www.nayuki.io/page/qr-code-generator-library)
|
||||
Home page for the main project with live JavaScript demo, extensive descriptions, and competitor comparisons: https://www.nayuki.io/page/qr-code-generator-library
|
||||
|
||||
|
||||
Features
|
||||
@ -17,12 +17,14 @@ Features
|
||||
|
||||
Core features:
|
||||
|
||||
* Approximately 1.5× to 10× faster than other Java implementation
|
||||
* Shorter code but more documentation comments compared to competing libraries
|
||||
* Supports encoding all 40 versions (sizes) and all 4 error correction levels, as per the QR Code Model 2 standard
|
||||
* Output format: Raw modules/pixels of the QR symbol
|
||||
* Detects finder-like penalty patterns more accurately than other implementations
|
||||
* Encodes numeric and special-alphanumeric text in less space than general text
|
||||
* Encodes Japanese Unicode text in kanji mode to save a lot of space compared to UTF-8 bytes
|
||||
* Computes optimal segment mode switching for text with mixed numeric/alphanumeric/general/kanji parts
|
||||
* Detects finder-like penalty patterns more accurately than other implementations
|
||||
* Open-source code under the permissive MIT License
|
||||
|
||||
Manual parameters:
|
||||
@ -38,47 +40,26 @@ More information about QR Code technology and this library's design can be found
|
||||
Examples
|
||||
--------
|
||||
|
||||
import java.awt.image.BufferedImage;
|
||||
import java.io.File;
|
||||
import java.util.List;
|
||||
import javax.imageio.ImageIO;
|
||||
import io.nayuki.fastqrcodegen.*;
|
||||
|
||||
// Simple operation
|
||||
QrCode qr0 = QrCode.encodeText("Hello, world!", QrCode.Ecc.MEDIUM);
|
||||
BufferedImage img = toImage(qr0, 4, 10); // See QrCodeGeneratorDemo
|
||||
ImageIO.write(img, "png", new File("qr-code.png"));
|
||||
|
||||
// Manual operation
|
||||
List<QrSegment> segs = QrSegment.makeSegments("3141592653589793238462643383");
|
||||
QrCode qr1 = QrCode.encodeSegments(segs, QrCode.Ecc.HIGH, 5, 5, 2, false);
|
||||
for (int y = 0; y < qr1.size; y++) {
|
||||
for (int x = 0; x < qr1.size; x++) {
|
||||
(... paint qr1.getModule(x, y) ...)
|
||||
}
|
||||
```java
|
||||
import java.awt.image.BufferedImage;
|
||||
import java.io.File;
|
||||
import java.util.List;
|
||||
import javax.imageio.ImageIO;
|
||||
import io.nayuki.fastqrcodegen.*;
|
||||
|
||||
// Simple operation
|
||||
QrCode qr0 = QrCode.encodeText("Hello, world!", QrCode.Ecc.MEDIUM);
|
||||
BufferedImage img = toImage(qr0, 4, 10); // See QrCodeGeneratorDemo
|
||||
ImageIO.write(img, "png", new File("qr-code.png"));
|
||||
|
||||
// Manual operation
|
||||
List<QrSegment> segs = QrSegment.makeSegments("3141592653589793238462643383");
|
||||
QrCode qr1 = QrCode.encodeSegments(segs, QrCode.Ecc.HIGH, 5, 5, 2, false);
|
||||
for (int y = 0; y < qr1.size; y++) {
|
||||
for (int x = 0; x < qr1.size; x++) {
|
||||
(... paint qr1.getModule(x, y) ...)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
Copyright © 2021 Project Nayuki. (MIT License)
|
||||
[https://www.nayuki.io/page/fast-qr-code-generator-library](https://www.nayuki.io/page/fast-qr-code-generator-library)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
* The Software is provided "as is", without warranty of any kind, express or
|
||||
implied, including but not limited to the warranties of merchantability,
|
||||
fitness for a particular purpose and noninfringement. In no event shall the
|
||||
authors or copyright holders be liable for any claim, damages or other
|
||||
liability, whether in an action of contract, tort or otherwise, arising from,
|
||||
out of or in connection with the Software or the use or other dealings in the
|
||||
Software.
|
||||
More complete set of examples: https://github.com/nayuki/QR-Code-generator/blob/master/java-fast/io/nayuki/fastqrcodegen/QrCodeGeneratorDemo.java .
|
||||
|
||||
@ -1,19 +1,21 @@
|
||||
/**
|
||||
* Generates QR Codes from text strings and byte arrays.
|
||||
*
|
||||
* <p>This library generates QR Code symbols, and its design is optimized for speed. It contrasts with another QR library by the same author which is slow but which optimizes for clarity and conciseness. The functionality of this library and its API are nearly identical to the slow library, but it runs anywhere from 1.5× to 6× as fast.</p>
|
||||
* <p>Home page for the fast library (design explanation, benchmarks): <a href="https://www.nayuki.io/page/fast-qr-code-generator-library">https://www.nayuki.io/page/fast-qr-code-generator-library</a></p>
|
||||
* <p>Home page for the slow library (live demo, QR Code introduction, competitor comparisons): <a href="https://www.nayuki.io/page/qr-code-generator-library">https://www.nayuki.io/page/qr-code-generator-library</a></p>
|
||||
* <p>This project aims to be the best, clearest QR Code generator library. The primary goals are flexible options and absolute correctness. Secondary goals are compact implementation size and good documentation comments.</p>
|
||||
* <p>Home page for this fast library with design explanation and benchmarks: <a href="https://www.nayuki.io/page/fast-qr-code-generator-library">https://www.nayuki.io/page/fast-qr-code-generator-library</a></p>
|
||||
* <p>Home page for the main project with live JavaScript demo, extensive descriptions, and competitor comparisons: <a href="https://www.nayuki.io/page/qr-code-generator-library">https://www.nayuki.io/page/qr-code-generator-library</a></p>
|
||||
*
|
||||
* <h2>Features</h2>
|
||||
* <p>Core features:</p>
|
||||
* <ul>
|
||||
* <li><p>Approximately 1.5× to 10× faster than other Java implementation</p></li>
|
||||
* <li><p>Shorter code but more documentation comments compared to competing libraries</p></li>
|
||||
* <li><p>Supports encoding all 40 versions (sizes) and all 4 error correction levels, as per the QR Code Model 2 standard</p></li>
|
||||
* <li><p>Output format: Raw modules/pixels of the QR symbol</p></li>
|
||||
* <li><p>Detects finder-like penalty patterns more accurately than other implementations</p></li>
|
||||
* <li><p>Encodes numeric and special-alphanumeric text in less space than general text</p></li>
|
||||
* <li><p>Encodes Japanese Unicode text in kanji mode to save a lot of space compared to UTF-8 bytes</p></li>
|
||||
* <li><p>Computes optimal segment mode switching for text with mixed numeric/alphanumeric/general/kanji parts</p></li>
|
||||
* <li><p>Detects finder-like penalty patterns more accurately than other implementations</p></li>
|
||||
* <li><p>Open-source code under the permissive MIT License</p></li>
|
||||
* </ul>
|
||||
* <p>Manual parameters:</p>
|
||||
|
||||
@ -10,6 +10,7 @@
|
||||
* <li><p>Significantly shorter code but more documentation comments compared to competing libraries</p></li>
|
||||
* <li><p>Supports encoding all 40 versions (sizes) and all 4 error correction levels, as per the QR Code Model 2 standard</p></li>
|
||||
* <li><p>Output format: Raw modules/pixels of the QR symbol</p></li>
|
||||
* <li><p>Detects finder-like penalty patterns more accurately than other implementations</p></li>
|
||||
* <li><p>Encodes numeric and special-alphanumeric text in less space than general text</p></li>
|
||||
* <li><p>Open-source code under the permissive MIT License</p></li>
|
||||
* </ul>
|
||||
|
||||
@ -69,6 +69,7 @@ Core features:
|
||||
* Significantly shorter code but more documentation comments compared to competing libraries
|
||||
* Supports encoding all 40 versions (sizes) and all 4 error correction levels, as per the QR Code Model 2 standard
|
||||
* Output format: Raw modules/pixels of the QR symbol
|
||||
* Detects finder-like penalty patterns more accurately than other implementations
|
||||
* Encodes numeric and special-alphanumeric text in less space than general text
|
||||
* Open-source code under the permissive MIT License
|
||||
|
||||
@ -82,12 +83,8 @@ Manual parameters:
|
||||
More information about QR Code technology and this library's design can be found on the project home page.
|
||||
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
Install this package by downloading the source code ZIP file from PyPI_, or by running ``pip install qrcodegen``.
|
||||
|
||||
Examples:
|
||||
Examples
|
||||
--------
|
||||
|
||||
::
|
||||
|
||||
@ -104,11 +101,7 @@ Examples:
|
||||
for x in range(qr1.get_size()):
|
||||
(... paint qr1.get_module(x, y) ...)
|
||||
|
||||
More complete set of examples: https://github.com/nayuki/QR-Code-generator/blob/master/python/qrcodegen-demo.py .
|
||||
|
||||
API documentation is in the source file itself, with a summary comment at the top: https://github.com/nayuki/QR-Code-generator/blob/master/python/qrcodegen.py .
|
||||
|
||||
.. _PyPI: https://pypi.python.org/pypi/qrcodegen""",
|
||||
More complete set of examples: https://github.com/nayuki/QR-Code-generator/blob/master/python/qrcodegen-demo.py .""",
|
||||
|
||||
py_modules = ["qrcodegen"],
|
||||
)
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
QR Code generator library
|
||||
=========================
|
||||
QR Code generator library - Rust
|
||||
================================
|
||||
|
||||
|
||||
Introduction
|
||||
@ -35,27 +35,30 @@ More information about QR Code technology and this library's design can be found
|
||||
Examples
|
||||
--------
|
||||
|
||||
extern crate qrcodegen;
|
||||
use qrcodegen::Mask;
|
||||
use qrcodegen::QrCode;
|
||||
use qrcodegen::QrCodeEcc;
|
||||
use qrcodegen::QrSegment;
|
||||
use qrcodegen::Version;
|
||||
|
||||
// Simple operation
|
||||
let qr = QrCode::encode_text("Hello, world!",
|
||||
QrCodeEcc::Medium).unwrap();
|
||||
let svg = to_svg_string(&qr, 4); // See qrcodegen-demo
|
||||
|
||||
// Manual operation
|
||||
let text: &str = "3141592653589793238462643383";
|
||||
let segs = QrSegment::make_segments(text);
|
||||
let qr = QrCode::encode_segments_advanced(&segs, QrCodeEcc::High,
|
||||
Version::new(5), Version::new(5), Some(Mask::new(2)), false).unwrap();
|
||||
for y in 0 .. qr.size() {
|
||||
for x in 0 .. qr.size() {
|
||||
(... paint qr.get_module(x, y) ...)
|
||||
}
|
||||
```rust
|
||||
extern crate qrcodegen;
|
||||
use qrcodegen::Mask;
|
||||
use qrcodegen::QrCode;
|
||||
use qrcodegen::QrCodeEcc;
|
||||
use qrcodegen::QrSegment;
|
||||
use qrcodegen::Version;
|
||||
|
||||
// Simple operation
|
||||
let qr = QrCode::encode_text("Hello, world!",
|
||||
QrCodeEcc::Medium).unwrap();
|
||||
let svg = to_svg_string(&qr, 4); // See qrcodegen-demo
|
||||
|
||||
// Manual operation
|
||||
let text: &str = "3141592653589793238462643383";
|
||||
let segs = QrSegment::make_segments(text);
|
||||
let qr = QrCode::encode_segments_advanced(&segs,
|
||||
QrCodeEcc::High, Version::new(5), Version::new(5),
|
||||
Some(Mask::new(2)), false).unwrap();
|
||||
for y in 0 .. qr.size() {
|
||||
for x in 0 .. qr.size() {
|
||||
(... paint qr.get_module(x, y) ...)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
More complete set of examples: https://github.com/nayuki/QR-Code-generator/blob/master/rust/examples/qrcodegen-demo.rs .
|
||||
|
||||
Loading…
Reference in New Issue
Block a user