diff options
| author | Sebastian Thiel <sebastian.thiel@icloud.com> | 2023-12-28 07:31:28 +0100 |
|---|---|---|
| committer | Sebastian Thiel <sebastian.thiel@icloud.com> | 2023-12-28 07:31:28 +0100 |
| commit | 729e7e92410b138f2778ef70f0f59a439028ac29 (patch) | |
| tree | 7bd6ab3d5397065a2f0f9f68c2dbb24ab3481999 /README.md | |
| parent | 196f0d62f32aacc2d393ef2929305a831a150520 (diff) | |
doc: clarify that (and why) `termion` isn't supported anymore in README.md (#208)
This was triggered by `crossterm` essentially breaking event handling
on Windows, which is when I decided to just use the seemingly more
powerful crossterm events natively.
Overall, this made event handling more complex, but also allows users of
`crosstermion` (the crate that actually dropped `termion` support) to
write even more interactive applications without worrying about
the always out-of-date intermediate layer.
Interestingly, the `crosstermion` crate adds some useful features around event handling,
but also optimizes build times thanks to `termion`, which is something that
on my current machine I don't notice anymore, so the value of it diminished greatly.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 11 |
1 files changed, 4 insertions, 7 deletions
@@ -155,13 +155,11 @@ make #### But why is… -#### …there two available backends? `crossterm` works everywhere! +#### …there only one available backend? `termion` was available previously. -Why add complexity to support `termion` if `crossterm` works everywhere? The answer is compile time and binary size, which both are larger -when using `crossterm`. Thus on Unix we still build with `termion`, but there is no reason to stop supporting it once `crossterm` has no -disadvantages. - -The `crosstermion` crate makes handling this a bit less cumbersome. +Maintaining both backends seemed more cumbersome than it's worth and add complexity I didn't like anymore. `termion` had its benefits, +but I never liked that it seems to have dropped out of support. +Thus `crossterm` is the only remaining backend and it's very actively developed. ### Acknowledgements @@ -205,5 +203,4 @@ Thanks to [jwalk][jwalk], all there was left to do is to write a command-line in [petgraph]: https://crates.io/crates/petgraph [rustup]: https://rustup.rs/ [jwalk]: https://crates.io/crates/jwalk -[termion]: https://crates.io/crates/termion [tui]: https://github.com/fdehau/tui-rs |