From 9b5106baa92bad84fb990ef0755d4e4f9793fbfb Mon Sep 17 00:00:00 2001 From: kolaente Date: Wed, 16 Sep 2020 20:10:29 +0200 Subject: [PATCH] Add readmes --- README.md | 12 ++++++++++++ README_DE.md | 13 +++++++++++++ 2 files changed, 25 insertions(+) create mode 100644 README.md create mode 100644 README_DE.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9af0557 --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# Bulk QR Code Creator + +This is a small program which takes all `.txt` files in a folder and creates qr codes with their contents. + +# Usage + +1. Get a release for your os from the [releases page](https://kolaente.dev/konrad/qrcode-bulk/releases). +2. Unzip the files into a folder of your choice. +3. Double click on the executable file (The only one ending on `.exe` for windows releases) or execute it via a terminal. +4. The tool will ask you for a folder with text files. You can hit enter to use the current directory from where you ran the binary. +5. It will show a progress bar for all files. +6. Once done, all generated qr codes will be put into a folder called `qrcodes` in the same directory as the text files. diff --git a/README_DE.md b/README_DE.md new file mode 100644 index 0000000..bf58a28 --- /dev/null +++ b/README_DE.md @@ -0,0 +1,13 @@ +# Bulk QR Code Creator + +Ein kleines Tool welches aus einem Ordner mit `.txt`-Dateien QR-Codes mit deren Inhalt erstellt. + +# Anleitung + +1. Besorg dir ein fertiges Binary für dein Betriebssystem von der [Release-Seite](https://kolaente.dev/konrad/qrcode-bulk/releases). +2. Entpacke die Zip-Datei in einen Ordner deiner Wahl. +3. Klicke doppelt auf die ausführbare Datei (Die einzige, die auf `.exe` endet bei Windows-Versionen) oder führe sie in einem Terminal aus. +4. Das Tool wird dich nach einem Ordner mit Textdateien fragen. Du kannst Enter drücken, um im aktuellen Ordner nach Textdateien zu suchen. +5. Während es die QR-Codes generiert wird es eine Fortschrittsanzeige anzeigen. +6. Wenn es fertig ist, werden alle QR-Codes im Ordner `qrcodes` im gleichen Ordner wie die Textdateien liegen +.