mirror of
https://github.com/ratatui-org/ratatui
synced 2024-11-24 21:53:21 +00:00
46902f5587
Overall makes improvements in the documentation of the workspace crates and checking them.
41 lines
1.4 KiB
Markdown
41 lines
1.4 KiB
Markdown
# Ratatui Core
|
|
|
|
[](https://crates.io/crates/ratatui-core)
|
|
[](https://docs.rs/ratatui-core)
|
|
[](../LICENSE)
|
|
|
|
<!-- ⚠️ DO NOT EDIT THIS FILE DIRECTLY, EDIT lib.rs AND THEN RUN `cargo rdme` to update this file. -->
|
|
<!-- cargo-rdme start -->
|
|
|
|
**ratatui-core** is the core library of the [ratatui] project,
|
|
providing the essential building blocks for creating rich terminal user interfaces in Rust.
|
|
|
|
[ratatui]: https://github.com/ratatui/ratatui
|
|
|
|
### 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.
|
|
|
|
<!-- cargo-rdme end -->
|