Updated the content of language-specific readme files and package-level documentation comments.

This commit is contained in:
Project Nayuki
2021-12-01 05:58:37 +00:00
parent a015ab50ad
commit e5f23aeda9
5 changed files with 66 additions and 86 deletions
+4 -11
View File
@@ -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"],
)