README added #1

Merged
epagris merged 3 commits from readme into master 2025-12-15 11:07:30 +01:00
Showing only changes of commit 8edb5f6dd5 - Show all commits

View File

@ -6,21 +6,21 @@ A tároló egy teljes, működő projektet tartalmaz.
## Bemenetek ## Bemenetek
- *Lehetséges piktogramok* a `logos` könyvtárban, - *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` könyvtárban elhelyezve. A táblázatnak a következő oszlopokat kell tartalmaznia: - *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 - `name`: hallgató neve
- `room`: terem megjelölése - `room`: terem megjelölése
- `barcode`: a vonalkódra/QR-kódra kerülő információ - `barcode`: a vonalkódra/QR-kódra kerülő információ
- `logo`: a jobb alsó sarokban megjelenített piktogram fájlneve a `logos` könyvtárhoz képest relatív elérési úttal, - `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. 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 ## Kimenetek
A generált matrica-oldalak a `pages` mappában fognak megjelenni. A generált matrica-oldalak a [`pages`](pages) mappában fognak megjelenni.
## Futtatás ## Futtatás
A matricák generálása a `gen_stickers.sh` script futtatásával történik, ami a `rooms` mappában található összes `.csv` táblázathoz előállítja a PDF oldalakat, amiket a `pages` mappába helyez végül. 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` mappába helyez végül.
### Függőségek ### Függőségek