doc: update README documentation
All checks were successful
Zig Project Action / Lint, Spell-check and test zig project (pull_request) Successful in 49s

This commit is contained in:
2024-11-13 19:47:13 +01:00
parent 570dfc3c3b
commit c47efefbc4

View File

@@ -4,49 +4,14 @@ This is my terminal based website. It is served as a tui application via ssh and
It contains information about me and my projects as well as blog entries about something I feel like writing something about.
## Terminal User Interface
## zterm
### Benchmark
This tui application also serves as an example implementation of the [zterm](https://gitea.yves-biener.de/yves-biener/zterm) library.
```sh
zig build -Dbenchmark run 2> log
```
_Press any button_ at the end of the benchmark (when you are back to the original screen). `log` now contains the frame
delay for each frame in each line of the output.
---
## Open tasks
- [ ] Improve navigation
- [ ] Have clickable/navigatable links inside of the tui application
- [ ] Launch simple http server alongside tui application
---
- [ ] Split into own repository
- [ ] Create other layouts
- [ ] horizontal stack
- [ ] vertical stack
- [ ] `Layout` in `Layout`? -> interfaces are very similar anyway
- [ ] Building Block `Layout`s
- [ ] Framing `Layout`
- [ ] Padding `Layout`
- [ ] Create demo gifs using [vhs](https://github.com/charmbracelet/vhs)
- [ ] Move documentation into new repository
- [ ] add dependency to new repository into this project
---
## Branch: `own-tty-visuals`
- [ ] How can I support to run a sub-process inside of a given pane / layout?
- [x] Could I simulate a corresponding event loop?
- emmit as many as possible through another thread (until the event queue is full?) [1023]
- see how fast the application can render each frame and measure the necessary time for each _frame_?
-> determine statistics like, min, max, median, mean, etc.
-> Or buffered writer to the `std.posix.STDOUT_FILENO`?
-> I could use this to see if it makes sense to implement a buffered version using a screen buffer (to only render the differences?)
- seems pretty good (with some exceptions)
- [ ] styling could be tricky with a given layout (which introduces corresponding line breaks ...)