diff --git a/README.md b/README.md new file mode 100644 index 0000000..7999ccd --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# Knights of Columbus QR Code Maker + +__quickstart__ +1. clone repo +2. cd to repo +3. `python3 -m venv venv` +4. `source venv/bin/activate` +5. `pip install -r requirements.txt` +6. `python3 main ` + +url: the url the QR code points to +file-name: the file name you want the qr code saved as. omit the file extension. + +The file will be saved at: `output/.png`