Skip to content

Latest commit

 

History

History
executable file
·
124 lines (84 loc) · 3.85 KB

README.md

File metadata and controls

executable file
·
124 lines (84 loc) · 3.85 KB
Raw

qrcode-cli

Build Status

QR Code SVG Encoder CLI

Usage

Usage: qrcode-cli DATA [options]
Version: 0.8.0

Options:
    -o, --output OUTPUT output path for the QR code image
    -e, --eclevel EC_LEVEL
                        error correction level (L, M, Q, H) (default: M)
    -c, --color COLOR   color of a module (default: "#000000")
    -t, --text          embed the original data on the QR code image (default:
                        false)
    -h, --help          print this help menu
    -v, --version       print version information

Build

Mac OS

git clone https://github.com/lbeder/qrcode-cli
cd qrcode-cli

cargo build --release

To get stuff working later, use the nightly branch of Rust:

rustup override set nightly

Install a standard Linux target on a Mac (note, that the opposite is currently impossible):

rustup target add x86_64-unknown-linux-musl

Use homebrew to download a community-provided binary for musl cross-compilation:

brew install FiloSottile/musl-cross/musl-cross

Now you can build it:

CROSS_COMPILE=x86_64-linux-musl cargo build --target=x86_64-unknown-linux-musl

Test

cargo test --release

Example

Let's see few QR code generation examples:

To encode Hello World using the L (up to ~7% damage):

./target/release/qrcode-cli -o images/example1.svg -e L "Hello World"

example1

To encode Hello World using the H (up to ~30% damage) with the embedding of the original data:

./target/release/qrcode-cli -o images/example2.svg -e H -t "Hello World"

example2

To encode a long message Hello World using the H (up to ~30% damage) with the embedding of the original data:

./target/release/qrcode-cli -o images/example3.svg -e H -t "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."

example3

To encode Hello World and render the QR code image in a different color:

./target/release/qrcode-cli -o images/example4.svg -c "#FF0000" "Hello World"

example4

License

MIT License

Copyright (c) 2019 Leonid Beder

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 NON-INFRINGEMENT. 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.