Directory graphics/pgf/contrib/qrcodetikz

qrcodetikz.sty --- prettier QR codes
===================================

Version
1.0 -> initial version, 2025-05-28

Copyright (C) 2025 Miguel V. S. Frasson (mvsfrasson@gmail.com)

LICENSE
=======

This file is the README file, part of the `qrcodetikz' package.

This package may be distributed under the terms of the LaTeX
Project Public License, as described in lppl.txt in the base
LaTeX distribution, either version 1.3 or (at your option)
any later version.

You can obtain a copy of the lppl.txt file from the internet on
http://www.latex-project.org/lppl.txt

INTRODUCTION
============

_qrcodetikz_ improves the display of QR codes provided by _qrcode_.

The Quick Response (QR) codes provided by package _qrcode_ show white
borders on each square (from little to very proeminent depending on
pdf viewer).  This is because the QR code is printed square by square,
not the connected regions of squares as such, and pdf screen viewers
show these undesired borders.

This package overwrites the _qrcode_ printing functions to fill
connected regions of the QR code using TikZ, allowing prettier qrcodes
on screen visualization, with possibility of customization.

USAGE
=====

Just load _qrcodetikz_ package, with same options as _qrcode_ package,
namely:
  nolinks: disable links if hyperref is loaded.

  draft: displays dummy QR code (doesn't compute QR code).

  final: computes and displays QR code (default).

  forget: recompute QR cades in every run, for debug purposes;
     without it, saves computed QR codes into aux file.

Use

  \qrcode{<text>}  or  \qrcode[<options>]{<text>}

where options are:

  height=<side length>: side lenght of the QR code, default is 2cm.
  
  level=<L,M,Q,H>: sets the quality of the error correction:
     L=low, M=medium (default), Q=Quality, H=high.

  version=<1-to-40>: sets the minimum size of the QR code.
     (In QR code jargon, version sets the size= 4 * <version> + 17.)

  padding: adds white space around QR code (4 modules in length)

  tight: opposite to padding, no white space added (default).

As QR codes are now printed with TikZ in a \fill command, user can add
fill options with \qrcodeFillOptions{<fill options>}, that have effect
until the next call of it.  Remove customizations with
\qrcodeFillOptions{}.