Add README for BirmingHack Check-in Application#1
Add README for BirmingHack Check-in Application#1MattyTheHacker wants to merge 5 commits intomainfrom
Conversation
Added detailed documentation for the BirmingHack check-in application, including system architecture, setup instructions, and usage guidelines. Signed-off-by: Matty Widdop <18513864+MattyTheHacker@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds a new top-level README documenting the BirmingHack check-in application, describing the system’s check-in/registration model, required hardware, and configuration steps for Tito + printer setup.
Changes:
- Documented application architecture (registration vs entry/exit toggling) and dual QR scanning (ticket QR + Student ID).
- Added setup instructions for dependencies,
config.yamlprinter USB IDs, and.envTito configuration. - Added operational notes for asset management and printer test printing.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Updated README to clarify application functionality and requirements. Signed-off-by: Matty Widdop <18513864+MattyTheHacker@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds a new top-level README documenting the BirmingHack check-in application so operators can set up the scanner + printer workflow and understand how Tito is used for registration/capacity state.
Changes:
- Documented the two Tito check-in lists used for “printed/registered” vs “entry/exit capacity” state.
- Added setup instructions for dependencies, printer USB config (
config.yaml), and Tito.envconfiguration. - Added operational usage notes (scan types, keyboard shortcuts, printer rate limiting, asset/image guidance).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Added a note about the requirement of git for installing dependencies and emphasized the importance of core API credentials for the application. Signed-off-by: Matty Widdop <18513864+MattyTheHacker@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds a comprehensive README for the BirmingHack check-in application to document architecture, setup/configuration, and operator usage.
Changes:
- Documented the two-list Tito-based state model (registration vs entry/exit capacity tracking).
- Added setup instructions for dependencies, printer
config.yaml, and Tito.envconfiguration (including required custom questions). - Documented operational usage (running the app, supported scan types, keyboard controls, assets).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Updated the README to clarify the printing of pizza tokens and reprint mode behavior. Enhanced the printer rate limiting explanation. Signed-off-by: Matty Widdop <18513864+MattyTheHacker@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds initial end-user documentation for the BirmingHack check-in application, covering architecture/state, setup (printer + Tito), and operational usage so the repo can be deployed and run more easily.
Changes:
- Documented the two Tito-list state model (registration vs entry/exit capacity tracking).
- Added setup instructions for dependencies, USB printer configuration (
config.yaml), and Tito/Core API env vars (.env). - Documented runtime usage, supported scan types, keyboard controls, and asset/image requirements.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 1. Registration State (Printed): The first time an attendee is scanned, the application prints a name badge. If the attendee provided a pizza preference, a pizza token is also printed. The attendee is then checked into the Registration list on Tito. On startup, the application downloads this list to know who has already received a badge. The application requires internet connectivity to Tito on startup to restore this state. | ||
| 2. Capacity State (Entry/Exit): Subsequent scans toggle the attendee's status on the Entry/Exit list in Tito. This tracks how many people are currently inside the venue. |
| Create a `.env` file in the root directory. | ||
|
|
||
| Core API credentials are strictly mandatory. If they are missing, the application cannot verify the Hackathons UK Data Sharing Agreement, and all check-ins will be rejected. | ||
|
|
||
| Important: Do not copy the placeholders literally. You must replace the `202X` and `your-...` values with your actual event year, slugs, and secrets. |
Clarified the description of attendee scan behavior and updated instructions for creating the .env file. Signed-off-by: Matty Widdop <18513864+MattyTheHacker@users.noreply.github.com>
Added detailed documentation for the BirmingHack check-in application, including system architecture, setup instructions, and usage guidelines.