readme
This commit is contained in:
parent
760fbf68e7
commit
e72693538d
1 changed files with 14 additions and 0 deletions
14
README.md
Normal file
14
README.md
Normal file
|
|
@ -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> <file-name>`
|
||||||
|
|
||||||
|
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/<file-name>.png`
|
||||||
Loading…
Reference in a new issue