mirror of https://github.com/ratatui-org/ratatui synced 2024-11-28 07:30:54 +00:00

History

Orhun Parmaksız 217c57cd60 refactor: modularize backends (#1508 ) Backend code is now moved to `ratatui-crossterm`, `ratatui-termion` and `ratatui-termwiz`. This should be backwards compatible with existing code. Co-authored-by: Josh McKinney <joshka@users.noreply.github.com>		2024-11-23 15:23:40 -08:00
..
src	refactor: modularize backends (#1508 )	2024-11-23 15:23:40 -08:00
Cargo.toml	refactor: modularize backends (#1508 )	2024-11-23 15:23:40 -08:00
README.md	docs: improve docs for workspace crates (#1490 )	2024-11-18 02:03:44 +03:00

README.md

Ratatui Core

ratatui-core is the core library of the ratatui project, providing the essential building blocks for creating rich terminal user interfaces in Rust.

Why `ratatui-core`?

The ratatui-core crate is split from the main ratatui crate to offer better stability for widget library authors. Widget libraries should generally depend on ratatui-core, benefiting from a stable API and reducing the need for frequent updates.

Applications, on the other hand, should depend on the main ratatui crate, which includes built-in widgets and additional features.

Installation

Add ratatui-core to your Cargo.toml:

cargo add ratatui-core

Contributing

We welcome contributions from the community! Please see our CONTRIBUTING guide for more details on how to get involved.

License