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.

build.zig

@@ -1,110 +1,42 @@
 const std = @import("std");
 
-// Although this function looks imperative, note that its job is to
-// declaratively construct a build graph that will be executed by an external
-// runner.
 pub fn build(b: *std.Build) void {
-    // Standard target options allows the person running `zig build` to choose
-    // what target to build for. Here we do not override the defaults, which
-    // means any target is allowed, and the default is native. Other options
-    // for restricting supported target set are available.
     const target = b.standardTargetOptions(.{});
-
-    // Standard optimization options allow the person running `zig build` to select
-    // between Debug, ReleaseSafe, ReleaseFast, and ReleaseSmall. Here we do not
-    // set a preferred release mode, allowing the user to decide how to optimize.
     const optimize = b.standardOptimizeOption(.{});
 
     const zg = b.dependency("zg", .{
         .target = target,
         .optimize = optimize,
     });
-    const interface = b.dependency("interface", .{
-        .target = target,
-        .optimize = optimize,
-    });
 
+    // library
     const lib = b.addModule("zterm", .{
         .root_source_file = b.path("src/zterm.zig"),
         .target = target,
         .optimize = optimize,
     });
-    lib.addImport("interface", interface.module("interface"));
     lib.addImport("code_point", zg.module("code_point"));
 
-    // example executables
-    const stack_example = b.addExecutable(.{
-        .name = "stack",
-        .root_source_file = b.path("examples/stack.zig"),
-        .target = target,
-        .optimize = optimize,
-    });
-    stack_example.root_module.addImport("zterm", lib);
+    // TODO: examples (not yet available)
+    // const stack_example = b.addExecutable(.{
+    //     .name = "stack",
+    //     .root_source_file = b.path("examples/stack.zig"),
+    //     .target = target,
+    //     .optimize = optimize,
+    // });
+    // stack_example.root_module.addImport("zterm", lib);
+    // b.installArtifact(stack_example);
 
-    const container_example = b.addExecutable(.{
-        .name = "container",
-        .root_source_file = b.path("examples/container.zig"),
-        .target = target,
-        .optimize = optimize,
-    });
-    container_example.root_module.addImport("zterm", lib);
-
-    const padding_example = b.addExecutable(.{
-        .name = "padding",
-        .root_source_file = b.path("examples/padding.zig"),
-        .target = target,
-        .optimize = optimize,
-    });
-    padding_example.root_module.addImport("zterm", lib);
-
-    const exec_example = b.addExecutable(.{
-        .name = "exec",
-        .root_source_file = b.path("examples/exec.zig"),
-        .target = target,
-        .optimize = optimize,
-    });
-    exec_example.root_module.addImport("zterm", lib);
-
-    const tui_example = b.addExecutable(.{
-        .name = "tui",
-        .root_source_file = b.path("examples/tui.zig"),
-        .target = target,
-        .optimize = optimize,
-    });
-    tui_example.root_module.addImport("zterm", lib);
-
-    const tabs_example = b.addExecutable(.{
-        .name = "tabs",
-        .root_source_file = b.path("examples/tabs.zig"),
-        .target = target,
-        .optimize = optimize,
-    });
-    tabs_example.root_module.addImport("zterm", lib);
-
-    // This declares intent for the executable to be installed into the
-    // standard location when the user invokes the "install" step (the default
-    // step when running `zig build`).
-    b.installArtifact(stack_example);
-    b.installArtifact(container_example);
-    b.installArtifact(padding_example);
-    b.installArtifact(exec_example);
-    b.installArtifact(tui_example);
-    b.installArtifact(tabs_example);
-
-    // Creates a step for unit testing. This only builds the test executable
-    // but does not run it.
+    // testing
     const lib_unit_tests = b.addTest(.{
         .root_source_file = b.path("src/zterm.zig"),
         .target = target,
         .optimize = optimize,
     });
-    lib_unit_tests.root_module.addImport("zg", zg.module("code_point"));
+    lib_unit_tests.root_module.addImport("code_point", zg.module("code_point"));
 
     const run_lib_unit_tests = b.addRunArtifact(lib_unit_tests);
 
-    // Similar to creating the run step earlier, this exposes a `test` step to
-    // the `zig build --help` menu, providing a way for the user to request
-    // running the unit tests.
     const test_step = b.step("test", "Run unit tests");
     test_step.dependOn(&run_lib_unit_tests.step);
 }