doc: update README
All checks were successful
Zig Project Action / Lint, Spell-check and test zig project (push) Successful in 42s
All checks were successful
Zig Project Action / Lint, Spell-check and test zig project (push) Successful in 42s
This commit is contained in:
17
README.md
17
README.md
@@ -1,9 +1,9 @@
|
||||
# zterm Terminal User Interface Library
|
||||
# zterm TUI Library
|
||||
|
||||
`zterm` is a terminal user interface library to implement terminal (fullscreen or inline) applications.
|
||||
`zterm` is a terminal user interface library (*tui*) to implement terminal (fullscreen or inline) applications.
|
||||
|
||||
> [!NOTE]
|
||||
> Only builds using the master version are tested to work.
|
||||
> [!CAUTION]
|
||||
> Only builds using the zig master version are tested to work.
|
||||
|
||||
## Demo
|
||||
|
||||
@@ -13,7 +13,7 @@ Clone this repository and run `zig build --help` to see the available examples.
|
||||
zig build --release=safe -Dexample=input run
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> [!TIP]
|
||||
> Every example application can be quit using `ctrl+c`.
|
||||
|
||||
See the [wiki](https://gitea.yves-biener.de/yves-biener/zterm/wiki) for a showcase of the examples and the further details.
|
||||
@@ -37,7 +37,6 @@ const zterm: *Dependency = b.dependency("zterm", .{
|
||||
exe.root_module.addImport("zterm", zterm.module("zterm"));
|
||||
```
|
||||
|
||||
---
|
||||
## Design Goals
|
||||
|
||||
This project draws heavy inspiration from
|
||||
@@ -80,7 +79,6 @@ via ssh. This provides security through the ssh protocol and can defer the
|
||||
synchronization process, as users may access the same running instance. Which is
|
||||
the primary use-case for myself to create this library in the first place.
|
||||
|
||||
---
|
||||
## Roadmap
|
||||
|
||||
- [ ] Container rendering
|
||||
@@ -150,8 +148,9 @@ the primary use-case for myself to create this library in the first place.
|
||||
- [x] Error Handling
|
||||
- log and show error's without crashing the application
|
||||
- [ ] Demo
|
||||
- [ ] use another tui application to launch and come back to (showcase the interrupt behavior)
|
||||
- [ ] Launch sub-applications (not inside of a `Container` but during the application workflow, like an editor)
|
||||
- [x] use another tui application to launch and come back to (showcase the interrupt behavior)
|
||||
- [x] Launch sub-applications (not inside of a `Container` but during the application workflow, like an editor)
|
||||
- [ ] implement some functionality to have it be more like a working demo application
|
||||
- [ ] Testability
|
||||
- [ ] snapshot ability to safe current screen (from `Renderer`) to test against
|
||||
- [ ] try to integrate them into the library itself such that they also serve as examples on how to test
|
||||
|
||||
Reference in New Issue
Block a user