From 1784816e993c6f69980bb3239774d5a2a7ad83c0 Mon Sep 17 00:00:00 2001 From: Mylloon Date: Sat, 11 May 2024 14:54:13 +0200 Subject: [PATCH] init(doc): readme --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1ca621c --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# Wi-Fi printer + +## Usage + +Put [`wifi.cls`](./wifi.cls) file along with your `.tex` file. + +In your `.tex` file : + +```latex +\documentclass{wifi} +``` + +Options available: + +| Option | Meaning | default | +| :------: | :--------------------- | --------- | +| `size` | Font size | `45` | +| `qrcode` | QR codes height | `7cm` | +| `border` | Border around QR codes | No border | + +Commands available: + +| Command | Meaning | +| :-----------------------: | :--------------------------------------- | +| `\qrc{ssid}{password}` | Insert a QR code | +| `\insertspaces{password}` | Insert a little space every 4 characters | + +## [Exemples](./examples) + +See [examples](./examples) of use.