Mirrors/ratatui
2
0
Fork 0
mirror of https://github.com/ratatui-org/ratatui synced 2024-11-21 20:23:11 +00:00
Code Issues Projects Releases Packages Wiki Activity
ratatui/ratatui-core/README.md

42 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

docs: improve docs for workspace crates (#1490) Overall makes improvements in the documentation of the workspace crates and checking them.
2024-11-17 23:03:44 +00:00
# Ratatui Core
chore(core): move core types to ratatui-core (#1460) The buffer, layout, style, symbols, text, and the top level of widgets modules are moved to ratatui-core. This is the first step in modularizing the library so that the core types can be used in other projects without the need for the backend / widgets types. This helps reduce the need for updating other crates as often due to semver changes outside of the core types. --------- Co-authored-by: Orhun Parmaksız <orhun@archlinux.org> Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
2024-11-06 06:10:49 +00:00
[![Crates.io](https://img.shields.io/crates/v/ratatui-core)](https://crates.io/crates/ratatui-core)
[![Documentation](https://docs.rs/ratatui-core/badge.svg)](https://docs.rs/ratatui-core)
[![License](https://img.shields.io/crates/l/ratatui-core)](../LICENSE)
docs: improve docs for workspace crates (#1490) Overall makes improvements in the documentation of the workspace crates and checking them.
2024-11-17 23:03:44 +00:00
<!-- ⚠️ DO NOT EDIT THIS FILE DIRECTLY, EDIT lib.rs AND THEN RUN `cargo rdme` to update this file. -->
<!-- cargo-rdme start -->
chore(core): move core types to ratatui-core (#1460) The buffer, layout, style, symbols, text, and the top level of widgets modules are moved to ratatui-core. This is the first step in modularizing the library so that the core types can be used in other projects without the need for the backend / widgets types. This helps reduce the need for updating other crates as often due to semver changes outside of the core types. --------- Co-authored-by: Orhun Parmaksız <orhun@archlinux.org> Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
2024-11-06 06:10:49 +00:00
docs: improve docs for workspace crates (#1490) Overall makes improvements in the documentation of the workspace crates and checking them.
2024-11-17 23:03:44 +00:00
**ratatui-core** is the core library of the [ratatui] project,
chore(core): move core types to ratatui-core (#1460) The buffer, layout, style, symbols, text, and the top level of widgets modules are moved to ratatui-core. This is the first step in modularizing the library so that the core types can be used in other projects without the need for the backend / widgets types. This helps reduce the need for updating other crates as often due to semver changes outside of the core types. --------- Co-authored-by: Orhun Parmaksız <orhun@archlinux.org> Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
2024-11-06 06:10:49 +00:00
providing the essential building blocks for creating rich terminal user interfaces in Rust.
docs: improve docs for workspace crates (#1490) Overall makes improvements in the documentation of the workspace crates and checking them.
2024-11-17 23:03:44 +00:00
[ratatui]: https://github.com/ratatui/ratatui
### Why `ratatui-core`?
chore(core): move core types to ratatui-core (#1460) The buffer, layout, style, symbols, text, and the top level of widgets modules are moved to ratatui-core. This is the first step in modularizing the library so that the core types can be used in other projects without the need for the backend / widgets types. This helps reduce the need for updating other crates as often due to semver changes outside of the core types. --------- Co-authored-by: Orhun Parmaksız <orhun@archlinux.org> Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
2024-11-06 06:10:49 +00:00
The `ratatui-core` crate is split from the main [`ratatui`](https://crates.io/crates/ratatui) crate
docs: improve docs for workspace crates (#1490) Overall makes improvements in the documentation of the workspace crates and checking them.
2024-11-17 23:03:44 +00:00
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.
chore(core): move core types to ratatui-core (#1460) The buffer, layout, style, symbols, text, and the top level of widgets modules are moved to ratatui-core. This is the first step in modularizing the library so that the core types can be used in other projects without the need for the backend / widgets types. This helps reduce the need for updating other crates as often due to semver changes outside of the core types. --------- Co-authored-by: Orhun Parmaksız <orhun@archlinux.org> Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
2024-11-06 06:10:49 +00:00
## Installation
Add `ratatui-core` to your `Cargo.toml`:
```shell
cargo add ratatui-core
```
## Contributing
docs: improve docs for workspace crates (#1490) Overall makes improvements in the documentation of the workspace crates and checking them.
2024-11-17 23:03:44 +00:00
We welcome contributions from the community! Please see our [CONTRIBUTING](../CONTRIBUTING.md)
guide for more details on how to get involved.
chore(core): move core types to ratatui-core (#1460) The buffer, layout, style, symbols, text, and the top level of widgets modules are moved to ratatui-core. This is the first step in modularizing the library so that the core types can be used in other projects without the need for the backend / widgets types. This helps reduce the need for updating other crates as often due to semver changes outside of the core types. --------- Co-authored-by: Orhun Parmaksız <orhun@archlinux.org> Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
2024-11-06 06:10:49 +00:00
docs: improve docs for workspace crates (#1490) Overall makes improvements in the documentation of the workspace crates and checking them.
2024-11-17 23:03:44 +00:00
### License
chore(core): move core types to ratatui-core (#1460) The buffer, layout, style, symbols, text, and the top level of widgets modules are moved to ratatui-core. This is the first step in modularizing the library so that the core types can be used in other projects without the need for the backend / widgets types. This helps reduce the need for updating other crates as often due to semver changes outside of the core types. --------- Co-authored-by: Orhun Parmaksız <orhun@archlinux.org> Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
2024-11-06 06:10:49 +00:00
This project is licensed under the MIT License. See the [LICENSE](../LICENSE) file for details.
docs: improve docs for workspace crates (#1490) Overall makes improvements in the documentation of the workspace crates and checking them.
2024-11-17 23:03:44 +00:00
<!-- cargo-rdme end -->
Reference in a new issue Copy permalink