mirror of
https://github.com/ratatui-org/ratatui
synced 2024-11-10 07:04:17 +00:00
doc: Updated readme and contributing guide with updates about the fork (#46)
* doc: Updated readme and contributing guide with updates about the fork * doc: added missing discord invite link
This commit is contained in:
Leon Sautour
GitHub
parent
fafad6c961
commit
bc5a9e4c06
2 changed files with 44 additions and 8 deletions
|
|
@ -1,3 +1,24 @@
|
|||
# Fork Status
|
||||
|
||||
## Pull Requests
|
||||
|
||||
**All** pull requests opened on the original repository have been imported. We'll be going through any open PRs in a timely manner, starting with the **smallest bug fixes and REAMDE updates**. If you have an open PR make sure to let us know about it on our [discord](https://discord.gg/pMCEU9hNEj) as it helps to know you are still active.
|
||||
|
||||
## Issues
|
||||
|
||||
We have been unsuccessfull in importing all issues opened on the previous repository.
|
||||
For that reason, anyone wanting to **work on or discuss** an issue will have to follow the following workflow :
|
||||
|
||||
- Recreate the issue
|
||||
- Start by referencing the **original issue**: ```Referencing issue #[<issue number>](<original issue link>)```
|
||||
- Then, paste the original issues **opening** text
|
||||
|
||||
You can then resume the conversation by replying to this new issue you have created.
|
||||
|
||||
### Closing Issues
|
||||
|
||||
If you close an issue that you have "imported" to this fork, please make sure that you add the issue to the **CLOSED_ISSUES.md**. This will enable us to keep track of which issues have been closed from the original repo, in case we are able to have the original repository transfered.
|
||||
|
||||
# Contributing
|
||||
|
||||
## Building
|
||||
|
|
@ -10,6 +31,8 @@ Building the project should be as easy as running `cargo make build`.
|
|||
|
||||
## :hammer_and_wrench: Pull requests
|
||||
|
||||
|
||||
|
||||
All contributions are obviously welcome.
|
||||
Please include as many details as possible in your PR description to help the reviewer (follow the provided template).
|
||||
Make sure to highlight changes which may need additional attention or you are uncertain about.
|
||||
|
|
|
|||
29
README.md
29
README.md
|
|
@ -6,6 +6,16 @@
|
|||
|
||||
<img src="./assets/demo.gif" alt="Demo cast under Linux Termite with Inconsolata font 12pt">
|
||||
|
||||
# What is this fork
|
||||
|
||||
This fork was created after the original repository was **no longer maintained**. The original maintainer had created an [issue](https://github.com/fdehau/tui-rs/issues/654) to which he didn't reply leaving us with no choice but to create this fork in order to **continue development on this crate.**
|
||||
|
||||
In order to organize ourselves, we have created a **temporary** [discord](https://discord.gg/pMCEU9hNEj) server. We have not yet determined with the community what will be our definitive communication medium.
|
||||
|
||||
Please make sure you read the updated contributing guidelines, especially if you are interested in working on a PR or issue opened in the previous repository.
|
||||
|
||||
# Introduction
|
||||
|
||||
`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
|
||||
|
|
@ -26,15 +36,16 @@ comes from the terminal emulator than the library itself.
|
|||
Moreover, the library does not provide any input handling nor any event system and
|
||||
you may rely on the previously cited libraries to achieve such features.
|
||||
|
||||
**I'm actively looking for help maintaining this crate. See [this issue](https://github.com/fdehau/tui-rs/issues/654)**
|
||||
|
||||
### Rust version requirements
|
||||
## Rust version requirements
|
||||
|
||||
Since version 0.17.0, `tui` requires **rustc version 1.56.1 or greater**.
|
||||
|
||||
### [Documentation](https://docs.rs/tui)
|
||||
# Documentation
|
||||
|
||||
### Demo
|
||||
The documentation can be found on [docs.rs.](https://docs.rs/tui)
|
||||
|
||||
# Demo
|
||||
|
||||
The demo shown in the gif can be run with all available backends.
|
||||
|
||||
|
|
@ -57,7 +68,9 @@ the demo without those symbols:
|
|||
cargo run --example demo --release -- --tick-rate 200 --enhanced-graphics false
|
||||
```
|
||||
|
||||
### Widgets
|
||||
# Widgets
|
||||
|
||||
## Built in
|
||||
|
||||
The library comes with the following list of widgets:
|
||||
|
||||
|
|
@ -78,13 +91,13 @@ cargo (e.g. to run the gauge example `cargo run --example gauge`), and quit by p
|
|||
You can run all examples by running `cargo make run-examples` (require
|
||||
`cargo-make` that can be installed with `cargo install cargo-make`).
|
||||
|
||||
### Third-party widgets
|
||||
## Third-party
|
||||
|
||||
* [tui-logger](https://github.com/gin66/tui-logger)
|
||||
* [tui-textarea](https://github.com/rhysd/tui-textarea): simple yet powerful multi-line text editor widget supporting several key shortcuts, undo/redo, text search, etc.
|
||||
* [tui-rs-tree-widgets](https://github.com/EdJoPaTo/tui-rs-tree-widget): widget for tree data structures.
|
||||
|
||||
### Apps using tui
|
||||
# Apps using tui
|
||||
|
||||
* [spotify-tui](https://github.com/Rigellute/spotify-tui)
|
||||
* [bandwhich](https://github.com/imsnif/bandwhich)
|
||||
|
|
@ -129,6 +142,6 @@ You can run all examples by running `cargo make run-examples` (require
|
|||
You might want to checkout [Cursive](https://github.com/gyscos/Cursive) for an
|
||||
alternative solution to build text user interfaces in Rust.
|
||||
|
||||
## License
|
||||
# License
|
||||
|
||||
[MIT](LICENSE)
|
||||
|
|
|
|||
Loading…
Reference in a new issue