mod(structure): update project structure

Remove examples, add description for design goals in README.md and
apply re-names and naming changes accordingly for the project structure.
Implement a flat hierachry, as the library shall remain pretty simple.

src/key.zig

@@ -0,0 +1,151 @@
+//! Keybindings and Modifiers for user input detection and selection.
+const std = @import("std");
+
+pub const Key = @This();
+
+pub const Modifier = struct {
+    shift: bool = false,
+    alt: bool = false,
+    ctrl: bool = false,
+};
+
+cp: u21,
+mod: Modifier = .{},
+
+/// Compare _this_ `Key` with an _other_ `Key`.
+///
+/// # Example
+///
+/// Configure `ctrl+c` to quit the application (done in main event loop of the application):
+///
+/// ```zig
+/// switch (event) {
+///     .quit => break,
+///     .key => |key| {
+///         // ctrl+c to quit
+///         if (terminal.Key.matches(key, .{ .cp = 'c', .mod = .{ .ctrl = true } })) {
+///             app.quit.set();
+///         }
+///     },
+///     else => {},
+/// }
+/// ```
+pub fn matches(this: @This(), other: @This()) bool {
+    return std.meta.eql(this, other);
+}
+
+// codepoints for keys
+pub const tab: u21 = 0x09;
+pub const enter: u21 = 0x0D;
+pub const escape: u21 = 0x1B;
+pub const space: u21 = 0x20;
+pub const backspace: u21 = 0x7F;
+
+// kitty key encodings (re-used here)
+pub const insert: u21 = 57348;
+pub const delete: u21 = 57349;
+pub const left: u21 = 57350;
+pub const right: u21 = 57351;
+pub const up: u21 = 57352;
+pub const down: u21 = 57353;
+pub const page_up: u21 = 57354;
+pub const page_down: u21 = 57355;
+pub const home: u21 = 57356;
+pub const end: u21 = 57357;
+pub const caps_lock: u21 = 57358;
+pub const scroll_lock: u21 = 57359;
+pub const num_lock: u21 = 57360;
+pub const print_screen: u21 = 57361;
+pub const pause: u21 = 57362;
+pub const menu: u21 = 57363;
+pub const f1: u21 = 57364;
+pub const f2: u21 = 57365;
+pub const f3: u21 = 57366;
+pub const f4: u21 = 57367;
+pub const f5: u21 = 57368;
+pub const f6: u21 = 57369;
+pub const f7: u21 = 57370;
+pub const f8: u21 = 57371;
+pub const f9: u21 = 57372;
+pub const f10: u21 = 57373;
+pub const f11: u21 = 57374;
+pub const f12: u21 = 57375;
+pub const f13: u21 = 57376;
+pub const f14: u21 = 57377;
+pub const f15: u21 = 57378;
+pub const @"f16": u21 = 57379;
+pub const f17: u21 = 57380;
+pub const f18: u21 = 57381;
+pub const f19: u21 = 57382;
+pub const f20: u21 = 57383;
+pub const f21: u21 = 57384;
+pub const f22: u21 = 57385;
+pub const f23: u21 = 57386;
+pub const f24: u21 = 57387;
+pub const f25: u21 = 57388;
+pub const f26: u21 = 57389;
+pub const f27: u21 = 57390;
+pub const f28: u21 = 57391;
+pub const f29: u21 = 57392;
+pub const f30: u21 = 57393;
+pub const f31: u21 = 57394;
+pub const @"f32": u21 = 57395;
+pub const f33: u21 = 57396;
+pub const f34: u21 = 57397;
+pub const f35: u21 = 57398;
+pub const kp_0: u21 = 57399;
+pub const kp_1: u21 = 57400;
+pub const kp_2: u21 = 57401;
+pub const kp_3: u21 = 57402;
+pub const kp_4: u21 = 57403;
+pub const kp_5: u21 = 57404;
+pub const kp_6: u21 = 57405;
+pub const kp_7: u21 = 57406;
+pub const kp_8: u21 = 57407;
+pub const kp_9: u21 = 57408;
+pub const kp_decimal: u21 = 57409;
+pub const kp_divide: u21 = 57410;
+pub const kp_multiply: u21 = 57411;
+pub const kp_subtract: u21 = 57412;
+pub const kp_add: u21 = 57413;
+pub const kp_enter: u21 = 57414;
+pub const kp_equal: u21 = 57415;
+pub const kp_separator: u21 = 57416;
+pub const kp_left: u21 = 57417;
+pub const kp_right: u21 = 57418;
+pub const kp_up: u21 = 57419;
+pub const kp_down: u21 = 57420;
+pub const kp_page_up: u21 = 57421;
+pub const kp_page_down: u21 = 57422;
+pub const kp_home: u21 = 57423;
+pub const kp_end: u21 = 57424;
+pub const kp_insert: u21 = 57425;
+pub const kp_delete: u21 = 57426;
+pub const kp_begin: u21 = 57427;
+pub const media_play: u21 = 57428;
+pub const media_pause: u21 = 57429;
+pub const media_play_pause: u21 = 57430;
+pub const media_reverse: u21 = 57431;
+pub const media_stop: u21 = 57432;
+pub const media_fast_forward: u21 = 57433;
+pub const media_rewind: u21 = 57434;
+pub const media_track_next: u21 = 57435;
+pub const media_track_previous: u21 = 57436;
+pub const media_record: u21 = 57437;
+pub const lower_volume: u21 = 57438;
+pub const raise_volume: u21 = 57439;
+pub const mute_volume: u21 = 57440;
+pub const left_shift: u21 = 57441;
+pub const left_control: u21 = 57442;
+pub const left_alt: u21 = 57443;
+pub const left_super: u21 = 57444;
+pub const left_hyper: u21 = 57445;
+pub const left_meta: u21 = 57446;
+pub const right_shift: u21 = 57447;
+pub const right_control: u21 = 57448;
+pub const right_alt: u21 = 57449;
+pub const right_super: u21 = 57450;
+pub const right_hyper: u21 = 57451;
+pub const right_meta: u21 = 57452;
+pub const iso_level_3_shift: u21 = 57453;
+pub const iso_level_5_shift: u21 = 57454;