diff --git a/README.md b/README.md index 2d45bd6..138e6ee 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,40 @@ # qr_labels +I was packing boxes and nerd-sniped myself by deciding I needed a labelling +and cataloguing system to help me keep track of what was there. + +To do that I needed to print labels for boxes, and figured it might be useful +if they also had QR codes on them. + +I thought there would be a simple online tool to create pages of identical +QR labels, but apparently not. + +# installing + + go install code.ppl.town/justin/qr_labels/cmd/qr_labels@latest + +or, you can just run it without installing: + + go run code.ppl.town/justin/qr_labels/cmd/qr_labels@latest + +# Synopsis + +Generate a page with 6 labels, where the QR code represents the string +"hello world" and the printed label is the same, + + qr_labels -code "hello world" -code-is-label -rows 3 -cols 2 -output labels1.pdf + +![hello world](labels1.png) + +Generate a page with 24 labels, with the code being a URL and the text label +being a different string. Adjust the sizes of the code and the font and include +borders between each label: + + qr_labels -code "https://www.youtube.com/watch?v=dQw4w9WgXcQ" -label 'innocent link' -rows 6 -cols 4 -size 30 -font-style BI -borders -font-size 20 -output labels2.pdf + +![hello world](labels2.png) + +# Help + +Run `qr_labels -help` for all command line parameters. + diff --git a/labels1.png b/labels1.png new file mode 100644 index 0000000..9e0b4c6 Binary files /dev/null and b/labels1.png differ diff --git a/labels2.png b/labels2.png new file mode 100644 index 0000000..32bbbbe Binary files /dev/null and b/labels2.png differ