Skip to content

Latest commit

 

History

History
126 lines (85 loc) · 2.81 KB

README.md

File metadata and controls

126 lines (85 loc) · 2.81 KB
Raw

qr

Print Unicode-friendly QR Codes® straight in your terminal!

qr-screencast

How to build

$ make
Build dependencies
  • libqrencode
    Resolve on Ubuntu or Debian
    $ apt-get install libqrencode-dev
    Resolve on macOS
    $ brew install qrencode
    Build from source
    $ git clone https://github.com/fukuchi/libqrencode.git && cd libqrencode
$ ./configure --prefix=/usr/local
$ make
# make install

How to install

# make install

or

$ sudo PREFIX=/usr/local make install

How to build and install using containers

$ docker build -t y2z/qr .
$ sudo install -b utils/qr.sh /usr/local/bin/qr

How to build and install on FreeBSD

$ pkg install qr

or

$ cd /usr/ports/textproc/qr/
$ make install clean

Usage

$ qr "Hello"

or

$ echo -n "Hello" | qr

Options

Usage: qr [OPTIONS] STRING
or:  cat FILE | qr [OPTIONS]

Options:
-m  QR mode       [na8k] (n = number, a = alphabet, 8 = 8-bit, k = Kanji)
-v  QR version    [1-40]
-e  QR EC level   [lmqh] or [1-4]
-l  use two characters per block
-c  compact mode
-b  border width  [1-4] (the default is 1)
-i  invert colors
-p  force colorless output
-h  print help info and exit
-V  print version info and exit

How to remove

# make uninstall

Running tests

$ make test
Test dependencies
  • autoconf
    Resolve on Ubuntu or Debian
    $ apt-get install autoconf
    Resolve on macOS
    $ brew install autoconf
  • zbar
    Resolve on Ubuntu or Debian
    $ apt-get install zbar-tools
    Resolve on macOS
    $ brew install zbar
  • imagemagick
    Resolve on Ubuntu or Debian
    $ apt-get install imagemagick
    Resolve on macOS
    $ brew install imagemagick
  • FreeMono font
    Resolve on Ubuntu or Debian
    $ apt-get install fonts-freefont-ttf
    Resolve on macOS
    $ brew tap homebrew/cask-fonts
$ brew install --cask font-freefont

Acknowledgements

QR Code is a registered trademark of DENSO WAVE INCORPORATED in Japan and other countries.

License

To the extent possible under law, the author(s) have dedicated all copyright related and neighboring rights to this software to the public domain worldwide. This software is distributed without any warranty.