mirror of
https://github.com/ratatui-org/ratatui
synced 2024-11-22 12:43:16 +00:00
e7085e3a3e
All the widgets now live in their own ratatui-widgets crate, but are re-exported in the main ratatui crate. This makes it easier to use portions of the ratatui library and is part of the effort to modularize Part of: #1388 --------- Co-authored-by: Orhun Parmaksız <orhun@archlinux.org> Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
35 lines
1.3 KiB
Markdown
35 lines
1.3 KiB
Markdown
# ratatui-core
|
|
|
|
[](https://crates.io/crates/ratatui-core)
|
|
[](https://docs.rs/ratatui-core)
|
|
[](../LICENSE)
|
|
|
|
## Overview
|
|
|
|
**ratatui-core** is the core library of the [ratatui](https://github.com/ratatui/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`](https://crates.io/crates/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`:
|
|
|
|
```shell
|
|
cargo add ratatui-core
|
|
```
|
|
|
|
## Contributing
|
|
|
|
We welcome contributions from the community! Please see our [CONTRIBUTING](../CONTRIBUTING.md) guide
|
|
for more details on how to get involved.
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License. See the [LICENSE](../LICENSE) file for details.
|