mirror of
https://github.com/ratatui-org/ratatui
synced 2024-11-10 07:04:17 +00:00
docs(readme): add install instruction and update title (#100)
This commit is contained in:
parent
ccd142df97
commit
c20fb723ef
1 changed files with 26 additions and 17 deletions
43
README.md
43
README.md
|
@ -1,11 +1,20 @@
|
|||
# tui-rs
|
||||
# ratatui
|
||||
|
||||
[![Build Status](https://github.com/fdehau/tui-rs/workflows/CI/badge.svg)](https://github.com/fdehau/tui-rs/actions?query=workflow%3ACI+)
|
||||
[![Crate Status](https://img.shields.io/crates/v/tui.svg)](https://crates.io/crates/tui)
|
||||
[![Docs Status](https://docs.rs/tui/badge.svg)](https://docs.rs/crate/tui/)
|
||||
A `tui`-rs fork.
|
||||
|
||||
[![Build Status](https://github.com/tui-rs-revival/ratatui/workflows/CI/badge.svg)](https://github.com/tui-rs-revival/ratatui/actions?query=workflow%3ACI+)
|
||||
[![Crate Status](https://img.shields.io/crates/v/tui.svg)](https://crates.io/crates/ratatui)
|
||||
[![Docs Status](https://docs.rs/ratatui/badge.svg)](https://docs.rs/crate/ratatui/)
|
||||
|
||||
<img src="./assets/demo.gif" alt="Demo cast under Linux Termite with Inconsolata font 12pt">
|
||||
|
||||
# Install
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
tui = { package = "ratatui" }
|
||||
```
|
||||
|
||||
# What is this fork?
|
||||
|
||||
This fork was created to continue maintenance on the original TUI project. The original maintainer had created an [issue](https://github.com/fdehau/tui-rs/issues/654) explaining how he couldn't find time to continue development, which led to us creating this fork. From here, we hope to continue developing the TUI crate.
|
||||
|
@ -16,7 +25,7 @@ Please make sure you read the updated contributing guidelines, especially if you
|
|||
|
||||
# Introduction
|
||||
|
||||
`tui-rs` is a [Rust](https://www.rust-lang.org) library to build rich terminal
|
||||
`tui`-rs is a [Rust](https://www.rust-lang.org) library to build rich terminal
|
||||
user interfaces and dashboards. It is heavily inspired by the `Javascript`
|
||||
library [blessed-contrib](https://github.com/yaronn/blessed-contrib) and the
|
||||
`Go` library [termui](https://github.com/gizak/termui).
|
||||
|
@ -58,8 +67,8 @@ cargo run --example demo --no-default-features --features=termion --release -- -
|
|||
|
||||
where `tick-rate` is the UI refresh rate in ms.
|
||||
|
||||
The UI code is in [examples/demo/ui.rs](https://github.com/fdehau/tui-rs/blob/v0.19.0/examples/demo/ui.rs) while the
|
||||
application state is in [examples/demo/app.rs](https://github.com/fdehau/tui-rs/blob/v0.19.0/examples/demo/app.rs).
|
||||
The UI code is in [examples/demo/ui.rs](https://github.com/tui-rs-revival/ratatui/blob/main/examples/demo/ui.rs) while the
|
||||
application state is in [examples/demo/app.rs](https://github.com/tui-rs-revival/ratatui/blob/main/examples/demo/app.rs).
|
||||
|
||||
If the user interface contains glyphs that are not displayed correctly by your terminal, you may want to run
|
||||
the demo without those symbols:
|
||||
|
@ -74,16 +83,16 @@ cargo run --example demo --release -- --tick-rate 200 --enhanced-graphics false
|
|||
|
||||
The library comes with the following list of widgets:
|
||||
|
||||
- [Block](https://github.com/fdehau/tui-rs/blob/v0.16.0/examples/block.rs)
|
||||
- [Gauge](https://github.com/fdehau/tui-rs/blob/v0.16.0/examples/gauge.rs)
|
||||
- [Sparkline](https://github.com/fdehau/tui-rs/blob/v0.16.0/examples/sparkline.rs)
|
||||
- [Chart](https://github.com/fdehau/tui-rs/blob/v0.16.0/examples/chart.rs)
|
||||
- [BarChart](https://github.com/fdehau/tui-rs/blob/v0.16.0/examples/barchart.rs)
|
||||
- [List](https://github.com/fdehau/tui-rs/blob/v0.16.0/examples/list.rs)
|
||||
- [Table](https://github.com/fdehau/tui-rs/blob/v0.16.0/examples/table.rs)
|
||||
- [Paragraph](https://github.com/fdehau/tui-rs/blob/v0.16.0/examples/paragraph.rs)
|
||||
- [Canvas (with line, point cloud, map)](https://github.com/fdehau/tui-rs/blob/v0.16.0/examples/canvas.rs)
|
||||
- [Tabs](https://github.com/fdehau/tui-rs/blob/v0.16.0/examples/tabs.rs)
|
||||
- [Block](https://github.com/tui-rs-revival/ratatui/blob/main/examples/block.rs)
|
||||
- [Gauge](https://github.com/tui-rs-revival/ratatui/blob/main/examples/gauge.rs)
|
||||
- [Sparkline](https://github.com/tui-rs-revival/ratatui/blob/main/examples/sparkline.rs)
|
||||
- [Chart](https://github.com/tui-rs-revival/ratatui/blob/main/examples/chart.rs)
|
||||
- [BarChart](https://github.com/tui-rs-revival/ratatui/blob/main/examples/barchart.rs)
|
||||
- [List](https://github.com/tui-rs-revival/ratatui/blob/main/examples/list.rs)
|
||||
- [Table](https://github.com/tui-rs-revival/ratatui/blob/main/examples/table.rs)
|
||||
- [Paragraph](https://github.com/tui-rs-revival/ratatui/blob/main/examples/paragraph.rs)
|
||||
- [Canvas (with line, point cloud, map)](https://github.com/tui-rs-revival/ratatui/blob/main/examples/canvas.rs)
|
||||
- [Tabs](https://github.com/tui-rs-revival/ratatui/blob/main/examples/tabs.rs)
|
||||
|
||||
Click on each item to see the source of the example. Run the examples with with
|
||||
cargo (e.g. to run the gauge example `cargo run --example gauge`), and quit by pressing `q`.
|
||||
|
|
Loading…
Reference in a new issue