Yves Biener 853f4d9769
Some checks failed
Zig Project Action / Lint, Spell-check and test zig project (push) Failing after 56s
mod(event): documentation of unsupported creation of declarations during comptime
The functionality remains in the code, but will cause an compilation
error when the user provided tagged union for the application events
has declarations. This way it is at least explicit that no declarations
are supported (even if this is actually a nice to have).

For details see this [issue](https://github.com/ziglang/zig/issues/6709).
2025-07-17 23:15:45 +02:00
2024-11-09 19:07:10 +01:00
2025-07-11 22:38:47 +02:00
2024-11-13 19:01:53 +01:00
2025-02-28 15:58:46 +01:00

zterm TUI Library

zterm is a terminal user interface library (tui) to implement terminal (fullscreen or inline) applications.

Caution

Only builds using the zig master version are tested to work.

Demo

Clone this repository and run zig build --help to see the available examples. Run a given example as follows:

zig build --release=safe -Dexample=demo run

Tip

Every example application can be quit using ctrl+c.

See the wiki for a showcase of the examples and the further details.

Usage

To add or update zterm as a dependency in your project run the following command:

zig fetch --save git+https://gitea.yves-biener.de/yves-biener/zterm

Add the dependency to your module as follows in your build.zig:

const zterm: *Dependency = b.dependency("zterm", .{
    .target = target,
    .optimize = optimize,
});
// ...
exe.root_module.addImport("zterm", zterm.module("zterm"));

Documentation

A wiki should be created containing a bright overview of the structure and usage of the library. For details it should refer to the examples. The documentation should be minimal in terms of updateability in case the library changes. Maybe some documentation could be derived from the code documentation (there is a tool for this if I recall correctly).

Description
Terminal User Interface Library for TUI applications written in zig.
Readme MIT 2.9 MiB
Languages
Zig 100%