Skip to content

Commit 5fa3f81

Browse files
committed
Library advantages list at the documentation index page
1 parent ba78392 commit 5fa3f81

2 files changed

Lines changed: 12 additions & 2 deletions

File tree

docs/source/index.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
1-
Welcome to python-quirc's documentation!
1+
python-quirc
22
========================================
33

4+
**python-quirc** is a ctypes bindings for `quirc <http://www.dlbeer.co.nz/oss/quirc.html>`_, C library for QR codes recognition.
5+
6+
As well as a base library, it has a good features for QR code recognition:
7+
8+
* It is fast enough to be used with realtime video.
9+
* It has two levels API: high-level for quick and simple decoding and low-level for those, who wants to control everything.
10+
* It is small, and doesn't have any dependencies (except of the C library, of course).
11+
* It has a very small memory footprint.
12+
* It works under the CPython 2.5, 2.6, 2.7 and PyPy. Python 3k support is planned.
13+
414
Contents:
515

616
.. toctree::

docs/source/usage/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Usage
22
=====
33

4-
Library usage splits into two parts: *high-level* and *low-level* API.
4+
Library' usage splits into two parts: *high-level* and *low-level* API.
55

66
In a sunny and beautiful world you will need only a *high-level* API.
77
But if you are have not so much free memory or want to control whole the process, use a *low-level* API.

0 commit comments

Comments
 (0)