init(doc): readme

This commit is contained in:
Mylloon 2024-05-11 14:54:13 +02:00
parent 54eb439ca1
commit 1784816e99
Signed by: Anri
GPG key ID: A82D63DFF8D1317F

30
README.md Normal file
View file

@ -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.