From c990338a2371e0d91ded84b8a46a3bd43ea7cdde Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Wiesner=20Andr=C3=A1s?= Date: Mon, 15 Dec 2025 11:07:29 +0100 Subject: [PATCH] README added Reviewed-on: https://gitea.epagris.com/AutoMidterm/ID-stickers/pulls/1 --- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..bec86ea --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# ID-stickers + +Névreszóló matricák rácsszerű generálása *egyedi azonosító*, *név*, *terem*, *kurzus* megjelöléssel és egy jobb alsó sarokban megjelenített *piktogrammal* [5x13 elrendezésű, A4 etiketthez](https://www.pcx.hu//etikett-fortuna-38x21-2mm-univerzalis-6500-cimke-doboz-100-iv-doboz-01-01309-665992). + +A tároló egy teljes, működő projektet tartalmaz. + +## Bemenetek + +- *Lehetséges piktogramok* a [`logos`](logos) könyvtárban, +- *Hallgatók felsorolása* termenként különálló, **vesszővel tagolt** CSV fájlokban, a [`rooms`](rooms) könyvtárban elhelyezve. A táblázatnak a következő oszlopokat kell tartalmaznia: + - `name`: hallgató neve + - `room`: terem megjelölése + - `barcode`: a vonalkódra/QR-kódra kerülő információ + - `logo`: a jobb alsó sarokban megjelenített piktogram fájlneve a [`logos`](logos) könyvtárhoz képest relatív elérési úttal, + Ezeken felül a táblázat AMC-beli későbbi felhasználását megkönnyítendő, célszerű egy `id`, illetve egy `neptun` mezővel is ellátni a táblázatot. + +## Kimenetek + +A generált matrica-oldalak a [`pages`](pages) mappában fognak megjelenni. + +## Futtatás + +A matricák generálása a [`gen_stickers.sh`](gen_stickers.sh) script futtatásával történik, ami a [`barcode-gen.tex`](barcode-gen.tex) segítésgével a [`rooms`](rooms) mappában található összes `.csv` táblázathoz előállítja a matricákat tartalmazó PDF oldalakat, amiket a [`pages`](pages) mappába helyez végül. + +### Függőségek + +A fordításhoz `xelatex` és az alábbi LaTeX-csomagok megléte szükséges: +- `babel` +- `inputenc` +- `fontenc` +- `fontspec` +- `geometry` +- `csvsimple-13` +- `tabularx` +- `graphicsx` +- `pst-barcode` + +## Nyomtatás + +Az előállított oldalakat *teljes A4 oldalra történő illesztéssel* szükséges nyomtatni. A nyomtatás teszteséléhez használható a [grid.pdf](grid.pdf) fájl, ami egy, az etikett elrendezésével megegyező rácsot tartalmaz. + +## Credits + +Wiesner András, 2025. Készült a *Beágyazott információs rendszerek* és a *Digitális technika* tárgyakhoz. + +