init

README.md

@@ -0,0 +1,60 @@
+# QR Code Generator
+
+A simple QR code generator.
+
+## Features
+
+-   Generate QR codes from URLs
+-   Download as PNG or SVG
+-   Track how many times each QR code was scanned
+
+## Requirements
+
+-   Docker
+-   Docker Compose
+-   Make (optional, but recommended)
+-   Linux (tested environment)
+
+## Installation
+
+``` bash
+make install
+```
+
+## Usage
+
+Start the project:
+
+``` bash
+make watch
+```
+or 
+``` bash
+make up
+```
+
+Show all available commands:
+
+``` bash
+make help
+```
+
+## macOS / Windows
+
+The project was tested on Linux.
+
+If the Makefile does not work on your system, you can run the commands
+manually.
+
+All installation steps are located in:
+
+``` bash
+./.dev/.mk/system.mk
+```
+
+You can open this file and execute the commands step by step.
+
+## Notes
+
+-   Make sure Docker and Docker Compose are installed and running
+-   On non-Linux systems, some commands may require manual adjustment