mirror of
https://github.com/ratatui-org/ratatui
synced 2024-09-20 06:31:59 +00:00
chore(github): rename tui-rs-revival references to ratatui-org (#340)
This commit is contained in:
Orhun Parmaksız
GitHub
parent
b9290b35d1
commit
964190a859
7 changed files with 169 additions and 169 deletions
300
CHANGELOG.md
300
CHANGELOG.md
|
|
@ -4,93 +4,93 @@
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
|
|
||||||
- *(barchart)* Set custom text value in the bar ([#309](https://github.com/tui-rs-revival/ratatui/issues/309))
|
- *(barchart)* Set custom text value in the bar ([#309](https://github.com/ratatui-org/ratatui/issues/309))
|
||||||
- *(barchart)* Enable barchart groups ([#288](https://github.com/tui-rs-revival/ratatui/issues/288))
|
- *(barchart)* Enable barchart groups ([#288](https://github.com/ratatui-org/ratatui/issues/288))
|
||||||
- *(block)* Support for having more than one title ([#232](https://github.com/tui-rs-revival/ratatui/issues/232))
|
- *(block)* Support for having more than one title ([#232](https://github.com/ratatui-org/ratatui/issues/232))
|
||||||
- *(examples)* User_input example cursor movement ([#302](https://github.com/tui-rs-revival/ratatui/issues/302))
|
- *(examples)* User_input example cursor movement ([#302](https://github.com/ratatui-org/ratatui/issues/302))
|
||||||
- *(misc)* Make builder fn const ([#275](https://github.com/tui-rs-revival/ratatui/issues/275)) ([#275](https://github.com/tui-rs-revival/ratatui/issues/275))
|
- *(misc)* Make builder fn const ([#275](https://github.com/ratatui-org/ratatui/issues/275)) ([#275](https://github.com/ratatui-org/ratatui/issues/275))
|
||||||
- *(prelude)* Add a prelude ([#304](https://github.com/tui-rs-revival/ratatui/issues/304))
|
- *(prelude)* Add a prelude ([#304](https://github.com/ratatui-org/ratatui/issues/304))
|
||||||
- *(style)* Enable setting the underline color for crossterm ([#308](https://github.com/tui-rs-revival/ratatui/issues/308)) ([#310](https://github.com/tui-rs-revival/ratatui/issues/310))
|
- *(style)* Enable setting the underline color for crossterm ([#308](https://github.com/ratatui-org/ratatui/issues/308)) ([#310](https://github.com/ratatui-org/ratatui/issues/310))
|
||||||
- *(style)* Allow Modifiers add/remove in const ([#287](https://github.com/tui-rs-revival/ratatui/issues/287))
|
- *(style)* Allow Modifiers add/remove in const ([#287](https://github.com/ratatui-org/ratatui/issues/287))
|
||||||
- *(stylize)* Allow all widgets to be styled ([#289](https://github.com/tui-rs-revival/ratatui/issues/289))
|
- *(stylize)* Allow all widgets to be styled ([#289](https://github.com/ratatui-org/ratatui/issues/289))
|
||||||
- *(terminal)* Expose 'swap_buffers' method
|
- *(terminal)* Expose 'swap_buffers' method
|
||||||
- *(uncategorized)* Stylization shorthands ([#283](https://github.com/tui-rs-revival/ratatui/issues/283))
|
- *(uncategorized)* Stylization shorthands ([#283](https://github.com/ratatui-org/ratatui/issues/283))
|
||||||
- *(uncategorized)* Add scrollbar widget ([#228](https://github.com/tui-rs-revival/ratatui/issues/228))
|
- *(uncategorized)* Add scrollbar widget ([#228](https://github.com/ratatui-org/ratatui/issues/228))
|
||||||
|
|
||||||
### Bug Fixes
|
### Bug Fixes
|
||||||
|
|
||||||
- *(clippy)* Unused_mut lint for layout ([#285](https://github.com/tui-rs-revival/ratatui/issues/285))
|
- *(clippy)* Unused_mut lint for layout ([#285](https://github.com/ratatui-org/ratatui/issues/285))
|
||||||
- *(examples)* Correct progress label in gague example ([#263](https://github.com/tui-rs-revival/ratatui/issues/263))
|
- *(examples)* Correct progress label in gague example ([#263](https://github.com/ratatui-org/ratatui/issues/263))
|
||||||
- *(layout)* Cap Constraint::apply to 100% length ([#264](https://github.com/tui-rs-revival/ratatui/issues/264))
|
- *(layout)* Cap Constraint::apply to 100% length ([#264](https://github.com/ratatui-org/ratatui/issues/264))
|
||||||
- *(lint)* Suspicious_double_ref_op is new in 1.71 ([#311](https://github.com/tui-rs-revival/ratatui/issues/311))
|
- *(lint)* Suspicious_double_ref_op is new in 1.71 ([#311](https://github.com/ratatui-org/ratatui/issues/311))
|
||||||
- *(prelude)* Remove widgets module from prelude ([#317](https://github.com/tui-rs-revival/ratatui/issues/317))
|
- *(prelude)* Remove widgets module from prelude ([#317](https://github.com/ratatui-org/ratatui/issues/317))
|
||||||
- *(title)* Remove default alignment and position ([#323](https://github.com/tui-rs-revival/ratatui/issues/323))
|
- *(title)* Remove default alignment and position ([#323](https://github.com/ratatui-org/ratatui/issues/323))
|
||||||
- *(typos)* Configure typos linter ([#233](https://github.com/tui-rs-revival/ratatui/issues/233))
|
- *(typos)* Configure typos linter ([#233](https://github.com/ratatui-org/ratatui/issues/233))
|
||||||
- *(uncategorized)* Rust-tui-template became a revival project ([#320](https://github.com/tui-rs-revival/ratatui/issues/320))
|
- *(uncategorized)* Rust-tui-template became a revival project ([#320](https://github.com/ratatui-org/ratatui/issues/320))
|
||||||
- *(uncategorized)* Revert removal of WTFPL from deny.toml ([#266](https://github.com/tui-rs-revival/ratatui/issues/266))
|
- *(uncategorized)* Revert removal of WTFPL from deny.toml ([#266](https://github.com/ratatui-org/ratatui/issues/266))
|
||||||
|
|
||||||
### Refactor
|
### Refactor
|
||||||
|
|
||||||
- *(ci)* Simplify cargo-make installation ([#240](https://github.com/tui-rs-revival/ratatui/issues/240))
|
- *(ci)* Simplify cargo-make installation ([#240](https://github.com/ratatui-org/ratatui/issues/240))
|
||||||
- *(text)* Simplify reflow implementation ([#290](https://github.com/tui-rs-revival/ratatui/issues/290))
|
- *(text)* Simplify reflow implementation ([#290](https://github.com/ratatui-org/ratatui/issues/290))
|
||||||
|
|
||||||
### Documentation
|
### Documentation
|
||||||
|
|
||||||
- *(color)* Parse more color formats and add docs ([#306](https://github.com/tui-rs-revival/ratatui/issues/306))
|
- *(color)* Parse more color formats and add docs ([#306](https://github.com/ratatui-org/ratatui/issues/306))
|
||||||
- *(lib)* Add `tui-term` a pseudoterminal library ([#268](https://github.com/tui-rs-revival/ratatui/issues/268))
|
- *(lib)* Add `tui-term` a pseudoterminal library ([#268](https://github.com/ratatui-org/ratatui/issues/268))
|
||||||
- *(lib)* Fixup tui refs in widgets/mod.rs ([#216](https://github.com/tui-rs-revival/ratatui/issues/216))
|
- *(lib)* Fixup tui refs in widgets/mod.rs ([#216](https://github.com/ratatui-org/ratatui/issues/216))
|
||||||
- *(lib)* Add backend docs ([#213](https://github.com/tui-rs-revival/ratatui/issues/213))
|
- *(lib)* Add backend docs ([#213](https://github.com/ratatui-org/ratatui/issues/213))
|
||||||
- *(readme)* Remove duplicated mention of tui-rs-tree-widgets ([#223](https://github.com/tui-rs-revival/ratatui/issues/223))
|
- *(readme)* Remove duplicated mention of tui-rs-tree-widgets ([#223](https://github.com/ratatui-org/ratatui/issues/223))
|
||||||
- *(uncategorized)* Improve CONTRIBUTING.md ([#277](https://github.com/tui-rs-revival/ratatui/issues/277))
|
- *(uncategorized)* Improve CONTRIBUTING.md ([#277](https://github.com/ratatui-org/ratatui/issues/277))
|
||||||
- *(uncategorized)* Fix scrollbar ascii illustrations and calendar doc paths ([#272](https://github.com/tui-rs-revival/ratatui/issues/272))
|
- *(uncategorized)* Fix scrollbar ascii illustrations and calendar doc paths ([#272](https://github.com/ratatui-org/ratatui/issues/272))
|
||||||
- *(uncategorized)* README tweaks ([#225](https://github.com/tui-rs-revival/ratatui/issues/225))
|
- *(uncategorized)* README tweaks ([#225](https://github.com/ratatui-org/ratatui/issues/225))
|
||||||
- *(uncategorized)* Add CODEOWNERS file ([#212](https://github.com/tui-rs-revival/ratatui/issues/212))
|
- *(uncategorized)* Add CODEOWNERS file ([#212](https://github.com/ratatui-org/ratatui/issues/212))
|
||||||
- *(uncategorized)* Update README.md and add hello_world example ([#204](https://github.com/tui-rs-revival/ratatui/issues/204))
|
- *(uncategorized)* Update README.md and add hello_world example ([#204](https://github.com/ratatui-org/ratatui/issues/204))
|
||||||
|
|
||||||
### Styling
|
### Styling
|
||||||
|
|
||||||
- *(comments)* Set comment length to wrap at 100 chars ([#218](https://github.com/tui-rs-revival/ratatui/issues/218))
|
- *(comments)* Set comment length to wrap at 100 chars ([#218](https://github.com/ratatui-org/ratatui/issues/218))
|
||||||
- *(config)* Apply formatting to config files ([#238](https://github.com/tui-rs-revival/ratatui/issues/238))
|
- *(config)* Apply formatting to config files ([#238](https://github.com/ratatui-org/ratatui/issues/238))
|
||||||
- *(manifest)* Apply formatting to Cargo.toml ([#237](https://github.com/tui-rs-revival/ratatui/issues/237))
|
- *(manifest)* Apply formatting to Cargo.toml ([#237](https://github.com/ratatui-org/ratatui/issues/237))
|
||||||
- *(readme)* Update the style of badges in README.md ([#299](https://github.com/tui-rs-revival/ratatui/issues/299))
|
- *(readme)* Update the style of badges in README.md ([#299](https://github.com/ratatui-org/ratatui/issues/299))
|
||||||
- *(widget)* Inline format arguments ([#279](https://github.com/tui-rs-revival/ratatui/issues/279))
|
- *(widget)* Inline format arguments ([#279](https://github.com/ratatui-org/ratatui/issues/279))
|
||||||
- *(uncategorized)* Fix formatting ([#292](https://github.com/tui-rs-revival/ratatui/issues/292))
|
- *(uncategorized)* Fix formatting ([#292](https://github.com/ratatui-org/ratatui/issues/292))
|
||||||
- *(uncategorized)* Reformat imports ([#219](https://github.com/tui-rs-revival/ratatui/issues/219))
|
- *(uncategorized)* Reformat imports ([#219](https://github.com/ratatui-org/ratatui/issues/219))
|
||||||
|
|
||||||
### Testing
|
### Testing
|
||||||
|
|
||||||
- *(barchart)* Add unit tests ([#301](https://github.com/tui-rs-revival/ratatui/issues/301))
|
- *(barchart)* Add unit tests ([#301](https://github.com/ratatui-org/ratatui/issues/301))
|
||||||
- *(paragraph)* Simplify paragraph benchmarks ([#282](https://github.com/tui-rs-revival/ratatui/issues/282))
|
- *(paragraph)* Simplify paragraph benchmarks ([#282](https://github.com/ratatui-org/ratatui/issues/282))
|
||||||
- *(uncategorized)* Add benchmarks for paragraph ([#262](https://github.com/tui-rs-revival/ratatui/issues/262))
|
- *(uncategorized)* Add benchmarks for paragraph ([#262](https://github.com/ratatui-org/ratatui/issues/262))
|
||||||
|
|
||||||
### Miscellaneous Tasks
|
### Miscellaneous Tasks
|
||||||
|
|
||||||
- *(ci)* Bump cargo-make version ([#239](https://github.com/tui-rs-revival/ratatui/issues/239))
|
- *(ci)* Bump cargo-make version ([#239](https://github.com/ratatui-org/ratatui/issues/239))
|
||||||
- *(ci)* Enable merge queue for builds ([#235](https://github.com/tui-rs-revival/ratatui/issues/235))
|
- *(ci)* Enable merge queue for builds ([#235](https://github.com/ratatui-org/ratatui/issues/235))
|
||||||
- *(ci)* Integrate cargo-deny for linting dependencies ([#221](https://github.com/tui-rs-revival/ratatui/issues/221))
|
- *(ci)* Integrate cargo-deny for linting dependencies ([#221](https://github.com/ratatui-org/ratatui/issues/221))
|
||||||
- *(commitizen)* Add commitizen config ([#222](https://github.com/tui-rs-revival/ratatui/issues/222))
|
- *(commitizen)* Add commitizen config ([#222](https://github.com/ratatui-org/ratatui/issues/222))
|
||||||
- *(demo)* Update demo gif ([#234](https://github.com/tui-rs-revival/ratatui/issues/234))
|
- *(demo)* Update demo gif ([#234](https://github.com/ratatui-org/ratatui/issues/234))
|
||||||
- *(demo)* Update demo gif with a fixed unicode gauge ([#227](https://github.com/tui-rs-revival/ratatui/issues/227))
|
- *(demo)* Update demo gif with a fixed unicode gauge ([#227](https://github.com/ratatui-org/ratatui/issues/227))
|
||||||
- *(features)* Enable building with all-features ([#286](https://github.com/tui-rs-revival/ratatui/issues/286))
|
- *(features)* Enable building with all-features ([#286](https://github.com/ratatui-org/ratatui/issues/286))
|
||||||
- *(github)* Add EditorConfig config ([#300](https://github.com/tui-rs-revival/ratatui/issues/300))
|
- *(github)* Add EditorConfig config ([#300](https://github.com/ratatui-org/ratatui/issues/300))
|
||||||
- *(github)* Simplify the CODEOWNERS file ([#271](https://github.com/tui-rs-revival/ratatui/issues/271))
|
- *(github)* Simplify the CODEOWNERS file ([#271](https://github.com/ratatui-org/ratatui/issues/271))
|
||||||
- *(github)* Add pull request template ([#269](https://github.com/tui-rs-revival/ratatui/issues/269))
|
- *(github)* Add pull request template ([#269](https://github.com/ratatui-org/ratatui/issues/269))
|
||||||
- *(github)* Fix the syntax in CODEOWNERS file ([#236](https://github.com/tui-rs-revival/ratatui/issues/236))
|
- *(github)* Fix the syntax in CODEOWNERS file ([#236](https://github.com/ratatui-org/ratatui/issues/236))
|
||||||
- *(license)* Add Ratatui developers to license ([#297](https://github.com/tui-rs-revival/ratatui/issues/297))
|
- *(license)* Add Ratatui developers to license ([#297](https://github.com/ratatui-org/ratatui/issues/297))
|
||||||
- *(tests)* Add coverage job to bacon ([#312](https://github.com/tui-rs-revival/ratatui/issues/312))
|
- *(tests)* Add coverage job to bacon ([#312](https://github.com/ratatui-org/ratatui/issues/312))
|
||||||
- *(uncategorized)* Lint and doc cleanup ([#191](https://github.com/tui-rs-revival/ratatui/issues/191))
|
- *(uncategorized)* Lint and doc cleanup ([#191](https://github.com/ratatui-org/ratatui/issues/191))
|
||||||
|
|
||||||
### Build
|
### Build
|
||||||
|
|
||||||
- *(deps)* Upgrade bitflags to 2.3 ([#205](https://github.com/tui-rs-revival/ratatui/issues/205)) [**breaking**]
|
- *(deps)* Upgrade bitflags to 2.3 ([#205](https://github.com/ratatui-org/ratatui/issues/205)) [**breaking**]
|
||||||
- *(uncategorized)* Add git pre-push hooks using cargo-husky ([#274](https://github.com/tui-rs-revival/ratatui/issues/274))
|
- *(uncategorized)* Add git pre-push hooks using cargo-husky ([#274](https://github.com/ratatui-org/ratatui/issues/274))
|
||||||
|
|
||||||
### Continuous Integration
|
### Continuous Integration
|
||||||
|
|
||||||
- *(makefile)* Split CI jobs ([#278](https://github.com/tui-rs-revival/ratatui/issues/278))
|
- *(makefile)* Split CI jobs ([#278](https://github.com/ratatui-org/ratatui/issues/278))
|
||||||
- *(uncategorized)* Parallelize CI jobs ([#318](https://github.com/tui-rs-revival/ratatui/issues/318))
|
- *(uncategorized)* Parallelize CI jobs ([#318](https://github.com/ratatui-org/ratatui/issues/318))
|
||||||
- *(uncategorized)* Add feat-wrapping on push and on pull request ci triggers ([#267](https://github.com/tui-rs-revival/ratatui/issues/267))
|
- *(uncategorized)* Add feat-wrapping on push and on pull request ci triggers ([#267](https://github.com/ratatui-org/ratatui/issues/267))
|
||||||
- *(uncategorized)* Add code coverage action ([#209](https://github.com/tui-rs-revival/ratatui/issues/209))
|
- *(uncategorized)* Add code coverage action ([#209](https://github.com/ratatui-org/ratatui/issues/209))
|
||||||
|
|
||||||
### Contributors
|
### Contributors
|
||||||
|
|
||||||
|
|
@ -114,71 +114,71 @@ Here is the list of contributors who have contributed to `ratatui` for the first
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
|
|
||||||
- *(backend)* Add termwiz backend and example ([#5](https://github.com/tui-rs-revival/ratatui/issues/5))
|
- *(backend)* Add termwiz backend and example ([#5](https://github.com/ratatui-org/ratatui/issues/5))
|
||||||
- *(block)* Support placing the title on bottom ([#36](https://github.com/tui-rs-revival/ratatui/issues/36))
|
- *(block)* Support placing the title on bottom ([#36](https://github.com/ratatui-org/ratatui/issues/36))
|
||||||
- *(border)* Add border! macro for easy bitflag manipulation ([#11](https://github.com/tui-rs-revival/ratatui/issues/11))
|
- *(border)* Add border! macro for easy bitflag manipulation ([#11](https://github.com/ratatui-org/ratatui/issues/11))
|
||||||
- *(calendar)* Add calendar widget ([#138](https://github.com/tui-rs-revival/ratatui/issues/138))
|
- *(calendar)* Add calendar widget ([#138](https://github.com/ratatui-org/ratatui/issues/138))
|
||||||
- *(color)* Add `FromStr` implementation for `Color` ([#180](https://github.com/tui-rs-revival/ratatui/issues/180))
|
- *(color)* Add `FromStr` implementation for `Color` ([#180](https://github.com/ratatui-org/ratatui/issues/180))
|
||||||
- *(list)* Add len() to List ([#24](https://github.com/tui-rs-revival/ratatui/pull/24))
|
- *(list)* Add len() to List ([#24](https://github.com/ratatui-org/ratatui/pull/24))
|
||||||
- *(paragraph)* Allow Lines to be individually aligned ([#149](https://github.com/tui-rs-revival/ratatui/issues/149))
|
- *(paragraph)* Allow Lines to be individually aligned ([#149](https://github.com/ratatui-org/ratatui/issues/149))
|
||||||
- *(sparkline)* Finish #1 Sparkline directions PR ([#134](https://github.com/tui-rs-revival/ratatui/issues/134))
|
- *(sparkline)* Finish #1 Sparkline directions PR ([#134](https://github.com/ratatui-org/ratatui/issues/134))
|
||||||
- *(terminal)* Add inline viewport ([#114](https://github.com/tui-rs-revival/ratatui/issues/114)) [**breaking**]
|
- *(terminal)* Add inline viewport ([#114](https://github.com/ratatui-org/ratatui/issues/114)) [**breaking**]
|
||||||
- *(test)* Expose test buffer ([#160](https://github.com/tui-rs-revival/ratatui/issues/160))
|
- *(test)* Expose test buffer ([#160](https://github.com/ratatui-org/ratatui/issues/160))
|
||||||
- *(text)* Add `Masked` to display secure data ([#168](https://github.com/tui-rs-revival/ratatui/issues/168)) [**breaking**]
|
- *(text)* Add `Masked` to display secure data ([#168](https://github.com/ratatui-org/ratatui/issues/168)) [**breaking**]
|
||||||
- *(widget)* Add circle widget ([#159](https://github.com/tui-rs-revival/ratatui/issues/159))
|
- *(widget)* Add circle widget ([#159](https://github.com/ratatui-org/ratatui/issues/159))
|
||||||
- *(widget)* Add style methods to Span, Spans, Text ([#148](https://github.com/tui-rs-revival/ratatui/issues/148))
|
- *(widget)* Add style methods to Span, Spans, Text ([#148](https://github.com/ratatui-org/ratatui/issues/148))
|
||||||
- *(widget)* Support adding padding to Block ([#20](https://github.com/tui-rs-revival/ratatui/issues/20))
|
- *(widget)* Support adding padding to Block ([#20](https://github.com/ratatui-org/ratatui/issues/20))
|
||||||
- *(widget)* Add offset() and offset_mut() for table and list state ([#12](https://github.com/tui-rs-revival/ratatui/issues/12))
|
- *(widget)* Add offset() and offset_mut() for table and list state ([#12](https://github.com/ratatui-org/ratatui/issues/12))
|
||||||
|
|
||||||
### Bug Fixes
|
### Bug Fixes
|
||||||
|
|
||||||
- *(canvas)* Use full block for Marker::Block ([#133](https://github.com/tui-rs-revival/ratatui/issues/133)) [**breaking**]
|
- *(canvas)* Use full block for Marker::Block ([#133](https://github.com/ratatui-org/ratatui/issues/133)) [**breaking**]
|
||||||
- *(example)* Update input in examples to only use press events ([#129](https://github.com/tui-rs-revival/ratatui/issues/129))
|
- *(example)* Update input in examples to only use press events ([#129](https://github.com/ratatui-org/ratatui/issues/129))
|
||||||
- *(uncategorized)* Cleanup doc example ([#145](https://github.com/tui-rs-revival/ratatui/issues/145))
|
- *(uncategorized)* Cleanup doc example ([#145](https://github.com/ratatui-org/ratatui/issues/145))
|
||||||
- *(reflow)* Remove debug macro call ([#198](https://github.com/tui-rs-revival/ratatui/issues/198))
|
- *(reflow)* Remove debug macro call ([#198](https://github.com/ratatui-org/ratatui/issues/198))
|
||||||
|
|
||||||
### Refactor
|
### Refactor
|
||||||
|
|
||||||
- *(example)* Remove redundant `vec![]` in `user_input` example ([#26](https://github.com/tui-rs-revival/ratatui/issues/26))
|
- *(example)* Remove redundant `vec![]` in `user_input` example ([#26](https://github.com/ratatui-org/ratatui/issues/26))
|
||||||
- *(example)* Refactor paragraph example ([#152](https://github.com/tui-rs-revival/ratatui/issues/152))
|
- *(example)* Refactor paragraph example ([#152](https://github.com/ratatui-org/ratatui/issues/152))
|
||||||
- *(style)* Mark some Style fns const so they can be defined globally ([#115](https://github.com/tui-rs-revival/ratatui/issues/115))
|
- *(style)* Mark some Style fns const so they can be defined globally ([#115](https://github.com/ratatui-org/ratatui/issues/115))
|
||||||
- *(text)* Replace `Spans` with `Line` ([#178](https://github.com/tui-rs-revival/ratatui/issues/178))
|
- *(text)* Replace `Spans` with `Line` ([#178](https://github.com/ratatui-org/ratatui/issues/178))
|
||||||
|
|
||||||
### Documentation
|
### Documentation
|
||||||
|
|
||||||
- *(apps)* Fix rsadsb/adsb_deku radar link ([#140](https://github.com/tui-rs-revival/ratatui/issues/140))
|
- *(apps)* Fix rsadsb/adsb_deku radar link ([#140](https://github.com/ratatui-org/ratatui/issues/140))
|
||||||
- *(apps)* Add tenere ([#141](https://github.com/tui-rs-revival/ratatui/issues/141))
|
- *(apps)* Add tenere ([#141](https://github.com/ratatui-org/ratatui/issues/141))
|
||||||
- *(apps)* Add twitch-tui ([#124](https://github.com/tui-rs-revival/ratatui/issues/124))
|
- *(apps)* Add twitch-tui ([#124](https://github.com/ratatui-org/ratatui/issues/124))
|
||||||
- *(apps)* Add oxycards ([#113](https://github.com/tui-rs-revival/ratatui/issues/113))
|
- *(apps)* Add oxycards ([#113](https://github.com/ratatui-org/ratatui/issues/113))
|
||||||
- *(apps)* Re-add trippy to APPS.md ([#117](https://github.com/tui-rs-revival/ratatui/issues/117))
|
- *(apps)* Re-add trippy to APPS.md ([#117](https://github.com/ratatui-org/ratatui/issues/117))
|
||||||
- *(block)* Add example for block.inner ([#158](https://github.com/tui-rs-revival/ratatui/issues/158))
|
- *(block)* Add example for block.inner ([#158](https://github.com/ratatui-org/ratatui/issues/158))
|
||||||
- *(changelog)* Update the empty profile link in contributors ([#112](https://github.com/tui-rs-revival/ratatui/issues/112))
|
- *(changelog)* Update the empty profile link in contributors ([#112](https://github.com/ratatui-org/ratatui/issues/112))
|
||||||
- *(readme)* Fix small typo in readme ([#186](https://github.com/tui-rs-revival/ratatui/issues/186))
|
- *(readme)* Fix small typo in readme ([#186](https://github.com/ratatui-org/ratatui/issues/186))
|
||||||
- *(readme)* Add termwiz demo to examples ([#183](https://github.com/tui-rs-revival/ratatui/issues/183))
|
- *(readme)* Add termwiz demo to examples ([#183](https://github.com/ratatui-org/ratatui/issues/183))
|
||||||
- *(readme)* Add acknowledgement section ([#154](https://github.com/tui-rs-revival/ratatui/issues/154))
|
- *(readme)* Add acknowledgement section ([#154](https://github.com/ratatui-org/ratatui/issues/154))
|
||||||
- *(readme)* Update project description ([#127](https://github.com/tui-rs-revival/ratatui/issues/127))
|
- *(readme)* Update project description ([#127](https://github.com/ratatui-org/ratatui/issues/127))
|
||||||
- *(uncategorized)* Scrape example code from examples/* ([#195](https://github.com/tui-rs-revival/ratatui/issues/195))
|
- *(uncategorized)* Scrape example code from examples/* ([#195](https://github.com/ratatui-org/ratatui/issues/195))
|
||||||
|
|
||||||
### Styling
|
### Styling
|
||||||
|
|
||||||
- *(apps)* Update the style of application list ([#184](https://github.com/tui-rs-revival/ratatui/issues/184))
|
- *(apps)* Update the style of application list ([#184](https://github.com/ratatui-org/ratatui/issues/184))
|
||||||
- *(readme)* Update project introduction in README.md ([#153](https://github.com/tui-rs-revival/ratatui/issues/153))
|
- *(readme)* Update project introduction in README.md ([#153](https://github.com/ratatui-org/ratatui/issues/153))
|
||||||
- *(uncategorized)* Clippy's variable inlining in format macros
|
- *(uncategorized)* Clippy's variable inlining in format macros
|
||||||
|
|
||||||
### Testing
|
### Testing
|
||||||
|
|
||||||
- *(buffer)* Add `assert_buffer_eq!` and Debug implementation ([#161](https://github.com/tui-rs-revival/ratatui/issues/161))
|
- *(buffer)* Add `assert_buffer_eq!` and Debug implementation ([#161](https://github.com/ratatui-org/ratatui/issues/161))
|
||||||
- *(list)* Add characterization tests for list ([#167](https://github.com/tui-rs-revival/ratatui/issues/167))
|
- *(list)* Add characterization tests for list ([#167](https://github.com/ratatui-org/ratatui/issues/167))
|
||||||
- *(widget)* Add unit tests for Paragraph ([#156](https://github.com/tui-rs-revival/ratatui/issues/156))
|
- *(widget)* Add unit tests for Paragraph ([#156](https://github.com/ratatui-org/ratatui/issues/156))
|
||||||
|
|
||||||
### Miscellaneous Tasks
|
### Miscellaneous Tasks
|
||||||
|
|
||||||
- *(uncategorized)* Inline format args ([#190](https://github.com/tui-rs-revival/ratatui/issues/190))
|
- *(uncategorized)* Inline format args ([#190](https://github.com/ratatui-org/ratatui/issues/190))
|
||||||
- *(uncategorized)* Minor lints, making Clippy happier ([#189](https://github.com/tui-rs-revival/ratatui/issues/189))
|
- *(uncategorized)* Minor lints, making Clippy happier ([#189](https://github.com/ratatui-org/ratatui/issues/189))
|
||||||
|
|
||||||
### Build
|
### Build
|
||||||
|
|
||||||
- *(uncategorized)* Bump MSRV to 1.65.0 ([#171](https://github.com/tui-rs-revival/ratatui/issues/171))
|
- *(uncategorized)* Bump MSRV to 1.65.0 ([#171](https://github.com/ratatui-org/ratatui/issues/171))
|
||||||
|
|
||||||
### Continuous Integration
|
### Continuous Integration
|
||||||
|
|
||||||
|
|
@ -210,12 +210,12 @@ Here is the list of contributors who have contributed to `ratatui` for the first
|
||||||
|
|
||||||
### Bug Fixes
|
### Bug Fixes
|
||||||
|
|
||||||
- *(style)* Bold needs a bit ([#104](https://github.com/tui-rs-revival/ratatui/issues/104))
|
- *(style)* Bold needs a bit ([#104](https://github.com/ratatui-org/ratatui/issues/104))
|
||||||
|
|
||||||
### Documentation
|
### Documentation
|
||||||
|
|
||||||
- *(apps)* Add "logss" to apps ([#105](https://github.com/tui-rs-revival/ratatui/issues/105))
|
- *(apps)* Add "logss" to apps ([#105](https://github.com/ratatui-org/ratatui/issues/105))
|
||||||
- *(uncategorized)* Fixup remaining tui references ([#106](https://github.com/tui-rs-revival/ratatui/issues/106))
|
- *(uncategorized)* Fixup remaining tui references ([#106](https://github.com/ratatui-org/ratatui/issues/106))
|
||||||
|
|
||||||
### Contributors
|
### Contributors
|
||||||
|
|
||||||
|
|
@ -235,67 +235,67 @@ Here is a list of changes:
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
|
|
||||||
- *(cd)* Add continuous deployment workflow ([#93](https://github.com/tui-rs-revival/ratatui/issues/93))
|
- *(cd)* Add continuous deployment workflow ([#93](https://github.com/ratatui-org/ratatui/issues/93))
|
||||||
- *(ci)* Add MacOS to CI ([#60](https://github.com/tui-rs-revival/ratatui/issues/60))
|
- *(ci)* Add MacOS to CI ([#60](https://github.com/ratatui-org/ratatui/issues/60))
|
||||||
- *(widget)* Add `offset()` to `TableState` ([#10](https://github.com/tui-rs-revival/ratatui/issues/10))
|
- *(widget)* Add `offset()` to `TableState` ([#10](https://github.com/ratatui-org/ratatui/issues/10))
|
||||||
- *(widget)* Add `width()` to ListItem ([#17](https://github.com/tui-rs-revival/ratatui/issues/17))
|
- *(widget)* Add `width()` to ListItem ([#17](https://github.com/ratatui-org/ratatui/issues/17))
|
||||||
|
|
||||||
### Bug Fixes
|
### Bug Fixes
|
||||||
|
|
||||||
- *(ci)* Test MSRV compatibility on CI ([#85](https://github.com/tui-rs-revival/ratatui/issues/85))
|
- *(ci)* Test MSRV compatibility on CI ([#85](https://github.com/ratatui-org/ratatui/issues/85))
|
||||||
- *(ci)* Bump Rust version to 1.63.0 ([#80](https://github.com/tui-rs-revival/ratatui/issues/80))
|
- *(ci)* Bump Rust version to 1.63.0 ([#80](https://github.com/ratatui-org/ratatui/issues/80))
|
||||||
- *(ci)* Use env for the cargo-make version ([#76](https://github.com/tui-rs-revival/ratatui/issues/76))
|
- *(ci)* Use env for the cargo-make version ([#76](https://github.com/ratatui-org/ratatui/issues/76))
|
||||||
- *(ci)* Fix deprecation warnings on CI ([#58](https://github.com/tui-rs-revival/ratatui/issues/58))
|
- *(ci)* Fix deprecation warnings on CI ([#58](https://github.com/ratatui-org/ratatui/issues/58))
|
||||||
- *(doc)* Add 3rd party libraries accidentally removed at #21 ([#61](https://github.com/tui-rs-revival/ratatui/issues/61))
|
- *(doc)* Add 3rd party libraries accidentally removed at #21 ([#61](https://github.com/ratatui-org/ratatui/issues/61))
|
||||||
- *(widget)* List should not ignore empty string items ([#42](https://github.com/tui-rs-revival/ratatui/issues/42)) [**breaking**]
|
- *(widget)* List should not ignore empty string items ([#42](https://github.com/ratatui-org/ratatui/issues/42)) [**breaking**]
|
||||||
- *(uncategorized)* Cassowary/layouts: add extra constraints for fixing Min(v)/Max(v) combination. ([#31](https://github.com/tui-rs-revival/ratatui/issues/31))
|
- *(uncategorized)* Cassowary/layouts: add extra constraints for fixing Min(v)/Max(v) combination. ([#31](https://github.com/ratatui-org/ratatui/issues/31))
|
||||||
- *(uncategorized)* Fix user_input example double key press registered on windows
|
- *(uncategorized)* Fix user_input example double key press registered on windows
|
||||||
- *(uncategorized)* Ignore zero-width symbol on rendering `Paragraph`
|
- *(uncategorized)* Ignore zero-width symbol on rendering `Paragraph`
|
||||||
- *(uncategorized)* Fix typos ([#45](https://github.com/tui-rs-revival/ratatui/issues/45))
|
- *(uncategorized)* Fix typos ([#45](https://github.com/ratatui-org/ratatui/issues/45))
|
||||||
- *(uncategorized)* Fix typos ([#47](https://github.com/tui-rs-revival/ratatui/issues/47))
|
- *(uncategorized)* Fix typos ([#47](https://github.com/ratatui-org/ratatui/issues/47))
|
||||||
|
|
||||||
### Refactor
|
### Refactor
|
||||||
|
|
||||||
- *(style)* Make bitflags smaller ([#13](https://github.com/tui-rs-revival/ratatui/issues/13))
|
- *(style)* Make bitflags smaller ([#13](https://github.com/ratatui-org/ratatui/issues/13))
|
||||||
|
|
||||||
### Documentation
|
### Documentation
|
||||||
|
|
||||||
- *(apps)* Move 'apps using ratatui' to dedicated file ([#98](https://github.com/tui-rs-revival/ratatui/issues/98)) ([#99](https://github.com/tui-rs-revival/ratatui/issues/99))
|
- *(apps)* Move 'apps using ratatui' to dedicated file ([#98](https://github.com/ratatui-org/ratatui/issues/98)) ([#99](https://github.com/ratatui-org/ratatui/issues/99))
|
||||||
- *(canvas)* Add documentation for x_bounds, y_bounds ([#35](https://github.com/tui-rs-revival/ratatui/issues/35))
|
- *(canvas)* Add documentation for x_bounds, y_bounds ([#35](https://github.com/ratatui-org/ratatui/issues/35))
|
||||||
- *(contributing)* Specify the use of unsafe for optimization ([#67](https://github.com/tui-rs-revival/ratatui/issues/67))
|
- *(contributing)* Specify the use of unsafe for optimization ([#67](https://github.com/ratatui-org/ratatui/issues/67))
|
||||||
- *(github)* Remove pull request template ([#68](https://github.com/tui-rs-revival/ratatui/issues/68))
|
- *(github)* Remove pull request template ([#68](https://github.com/ratatui-org/ratatui/issues/68))
|
||||||
- *(readme)* Update crate status badge ([#102](https://github.com/tui-rs-revival/ratatui/issues/102))
|
- *(readme)* Update crate status badge ([#102](https://github.com/ratatui-org/ratatui/issues/102))
|
||||||
- *(readme)* Small edits before first release ([#101](https://github.com/tui-rs-revival/ratatui/issues/101))
|
- *(readme)* Small edits before first release ([#101](https://github.com/ratatui-org/ratatui/issues/101))
|
||||||
- *(readme)* Add install instruction and update title ([#100](https://github.com/tui-rs-revival/ratatui/issues/100))
|
- *(readme)* Add install instruction and update title ([#100](https://github.com/ratatui-org/ratatui/issues/100))
|
||||||
- *(readme)* Add systeroid to application list ([#92](https://github.com/tui-rs-revival/ratatui/issues/92))
|
- *(readme)* Add systeroid to application list ([#92](https://github.com/ratatui-org/ratatui/issues/92))
|
||||||
- *(readme)* Add glicol-cli to showcase list ([#95](https://github.com/tui-rs-revival/ratatui/issues/95))
|
- *(readme)* Add glicol-cli to showcase list ([#95](https://github.com/ratatui-org/ratatui/issues/95))
|
||||||
- *(readme)* Add oxker to application list ([#74](https://github.com/tui-rs-revival/ratatui/issues/74))
|
- *(readme)* Add oxker to application list ([#74](https://github.com/ratatui-org/ratatui/issues/74))
|
||||||
- *(readme)* Add app kubectl-watch which uses tui ([#73](https://github.com/tui-rs-revival/ratatui/issues/73))
|
- *(readme)* Add app kubectl-watch which uses tui ([#73](https://github.com/ratatui-org/ratatui/issues/73))
|
||||||
- *(readme)* Add poketex to 'apps using tui' in README ([#64](https://github.com/tui-rs-revival/ratatui/issues/64))
|
- *(readme)* Add poketex to 'apps using tui' in README ([#64](https://github.com/ratatui-org/ratatui/issues/64))
|
||||||
- *(readme)* Update README.md ([#39](https://github.com/tui-rs-revival/ratatui/issues/39))
|
- *(readme)* Update README.md ([#39](https://github.com/ratatui-org/ratatui/issues/39))
|
||||||
- *(readme)* Update README.md ([#40](https://github.com/tui-rs-revival/ratatui/issues/40))
|
- *(readme)* Update README.md ([#40](https://github.com/ratatui-org/ratatui/issues/40))
|
||||||
- *(readme)* Clarify README.md fork status update
|
- *(readme)* Clarify README.md fork status update
|
||||||
- *(uncategorized)* Fix: fix typos ([#90](https://github.com/tui-rs-revival/ratatui/issues/90))
|
- *(uncategorized)* Fix: fix typos ([#90](https://github.com/ratatui-org/ratatui/issues/90))
|
||||||
- *(uncategorized)* Update to build more backends ([#81](https://github.com/tui-rs-revival/ratatui/issues/81))
|
- *(uncategorized)* Update to build more backends ([#81](https://github.com/ratatui-org/ratatui/issues/81))
|
||||||
- *(uncategorized)* Expand "Apps" and "Third-party" sections ([#21](https://github.com/tui-rs-revival/ratatui/issues/21))
|
- *(uncategorized)* Expand "Apps" and "Third-party" sections ([#21](https://github.com/ratatui-org/ratatui/issues/21))
|
||||||
- *(uncategorized)* Add tui-input and update xplr in README.md
|
- *(uncategorized)* Add tui-input and update xplr in README.md
|
||||||
- *(uncategorized)* Add hncli to list of applications made with tui-rs ([#41](https://github.com/tui-rs-revival/ratatui/issues/41))
|
- *(uncategorized)* Add hncli to list of applications made with tui-rs ([#41](https://github.com/ratatui-org/ratatui/issues/41))
|
||||||
- *(uncategorized)* Updated readme and contributing guide with updates about the fork ([#46](https://github.com/tui-rs-revival/ratatui/issues/46))
|
- *(uncategorized)* Updated readme and contributing guide with updates about the fork ([#46](https://github.com/ratatui-org/ratatui/issues/46))
|
||||||
|
|
||||||
### Performance
|
### Performance
|
||||||
|
|
||||||
- *(layout)* Better safe shared layout cache ([#62](https://github.com/tui-rs-revival/ratatui/issues/62))
|
- *(layout)* Better safe shared layout cache ([#62](https://github.com/ratatui-org/ratatui/issues/62))
|
||||||
|
|
||||||
### Miscellaneous Tasks
|
### Miscellaneous Tasks
|
||||||
|
|
||||||
- *(cargo)* Update project metadata ([#94](https://github.com/tui-rs-revival/ratatui/issues/94))
|
- *(cargo)* Update project metadata ([#94](https://github.com/ratatui-org/ratatui/issues/94))
|
||||||
- *(ci)* Integrate `typos` for checking typos ([#91](https://github.com/tui-rs-revival/ratatui/issues/91))
|
- *(ci)* Integrate `typos` for checking typos ([#91](https://github.com/ratatui-org/ratatui/issues/91))
|
||||||
- *(ci)* Change the target branch to main ([#79](https://github.com/tui-rs-revival/ratatui/issues/79))
|
- *(ci)* Change the target branch to main ([#79](https://github.com/ratatui-org/ratatui/issues/79))
|
||||||
- *(ci)* Re-enable clippy on CI ([#59](https://github.com/tui-rs-revival/ratatui/issues/59))
|
- *(ci)* Re-enable clippy on CI ([#59](https://github.com/ratatui-org/ratatui/issues/59))
|
||||||
- *(uncategorized)* Integrate `committed` for checking conventional commits ([#77](https://github.com/tui-rs-revival/ratatui/issues/77))
|
- *(uncategorized)* Integrate `committed` for checking conventional commits ([#77](https://github.com/ratatui-org/ratatui/issues/77))
|
||||||
- *(uncategorized)* Update `rust-version` to 1.59 in Cargo.toml ([#57](https://github.com/tui-rs-revival/ratatui/issues/57))
|
- *(uncategorized)* Update `rust-version` to 1.59 in Cargo.toml ([#57](https://github.com/ratatui-org/ratatui/issues/57))
|
||||||
- *(uncategorized)* Update deps ([#51](https://github.com/tui-rs-revival/ratatui/issues/51))
|
- *(uncategorized)* Update deps ([#51](https://github.com/ratatui-org/ratatui/issues/51))
|
||||||
- *(uncategorized)* Fix typo in layout.rs ([#619](https://github.com/tui-rs-revival/ratatui/issues/619))
|
- *(uncategorized)* Fix typo in layout.rs ([#619](https://github.com/ratatui-org/ratatui/issues/619))
|
||||||
- *(uncategorized)* Add apps using `tui`
|
- *(uncategorized)* Add apps using `tui`
|
||||||
|
|
||||||
### Contributors
|
### Contributors
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ creating a new issue before making the change, or starting a discussion on
|
||||||
|
|
||||||
## Reporting issues
|
## Reporting issues
|
||||||
|
|
||||||
Before reporting an issue on the [issue tracker](https://github.com/tui-rs-revival/ratatui/issues),
|
Before reporting an issue on the [issue tracker](https://github.com/ratatui-org/ratatui/issues),
|
||||||
please check that it has not already been reported by searching for some related keywords. Please
|
please check that it has not already been reported by searching for some related keywords. Please
|
||||||
also check [`tui-rs` issues](https://github.com/fdehau/tui-rs/issues/) and link any related issues
|
also check [`tui-rs` issues](https://github.com/fdehau/tui-rs/issues/) and link any related issues
|
||||||
found.
|
found.
|
||||||
|
|
@ -84,14 +84,14 @@ defaults depending on your platform of choice. Building the project should be as
|
||||||
`cargo make build`.
|
`cargo make build`.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
git clone https://github.com/tui-rs-revival/ratatui.git
|
git clone https://github.com/ratatui-org/ratatui.git
|
||||||
cd ratatui
|
cd ratatui
|
||||||
cargo make build
|
cargo make build
|
||||||
```
|
```
|
||||||
|
|
||||||
### Tests
|
### Tests
|
||||||
|
|
||||||
The [test coverage](https://app.codecov.io/gh/tui-rs-revival/ratatui) of the crate is reasonably
|
The [test coverage](https://app.codecov.io/gh/ratatui-org/ratatui) of the crate is reasonably
|
||||||
good, but this can always be improved. Focus on keeping the tests simple and obvious and write unit
|
good, but this can always be improved. Focus on keeping the tests simple and obvious and write unit
|
||||||
tests for all new or modified code. Beside the usual doc and unit tests, one of the most valuable
|
tests for all new or modified code. Beside the usual doc and unit tests, one of the most valuable
|
||||||
test you can write for Ratatui is a test against the `TestBackend`. It allows you to assert the
|
test you can write for Ratatui is a test against the `TestBackend`. It allows you to assert the
|
||||||
|
|
@ -117,7 +117,7 @@ exist to show coverage directly in your editor. E.g.:
|
||||||
|
|
||||||
We don't currently use any unsafe code in Ratatui, and would like to keep it that way. However there
|
We don't currently use any unsafe code in Ratatui, and would like to keep it that way. However there
|
||||||
may be specific cases that this becomes necessary in order to avoid slowness. Please see [this
|
may be specific cases that this becomes necessary in order to avoid slowness. Please see [this
|
||||||
discussion](https://github.com/tui-rs-revival/ratatui/discussions/66) for more about the decision.
|
discussion](https://github.com/ratatui-org/ratatui/discussions/66) for more about the decision.
|
||||||
|
|
||||||
## Continuous Integration
|
## Continuous Integration
|
||||||
|
|
||||||
|
|
@ -142,7 +142,7 @@ it is useful to refer to when contributing code, documentation, or issues with R
|
||||||
|
|
||||||
We imported all the PRs from the original repository and implemented many of the smaller ones and
|
We imported all the PRs from the original repository and implemented many of the smaller ones and
|
||||||
made notes on the leftovers. These are marked as draft PRs and labelled as [imported from
|
made notes on the leftovers. These are marked as draft PRs and labelled as [imported from
|
||||||
tui](https://github.com/tui-rs-revival/ratatui/pulls?q=is%3Apr+is%3Aopen+label%3A%22imported+from+tui%22).
|
tui](https://github.com/ratatui-org/ratatui/pulls?q=is%3Apr+is%3Aopen+label%3A%22imported+from+tui%22).
|
||||||
We have documented the current state of those PRs, and anyone is welcome to pick them up and
|
We have documented the current state of those PRs, and anyone is welcome to pick them up and
|
||||||
continue the work on them.
|
continue the work on them.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -5,7 +5,7 @@ authors = ["Florian Dehau <work@fdehau.com>", "The Ratatui Developers"]
|
||||||
description = "A library to build rich terminal user interfaces or dashboards"
|
description = "A library to build rich terminal user interfaces or dashboards"
|
||||||
documentation = "https://docs.rs/ratatui/latest/ratatui/"
|
documentation = "https://docs.rs/ratatui/latest/ratatui/"
|
||||||
keywords = ["tui", "terminal", "dashboard"]
|
keywords = ["tui", "terminal", "dashboard"]
|
||||||
repository = "https://github.com/tui-rs-revival/ratatui"
|
repository = "https://github.com/ratatui-org/ratatui"
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
exclude = [
|
exclude = [
|
||||||
|
|
|
||||||
18
README.md
18
README.md
|
|
@ -8,15 +8,15 @@ project.
|
||||||
|
|
||||||
[](https://crates.io/crates/ratatui)
|
[](https://crates.io/crates/ratatui)
|
||||||
[](./LICENSE) [](./LICENSE) [](https://github.com/tui-rs-revival/ratatui/actions?query=workflow%3ACI+)
|
Status](https://img.shields.io/github/actions/workflow/status/ratatui-org/ratatui/ci.yml?style=flat-square&logo=github)](https://github.com/ratatui-org/ratatui/actions?query=workflow%3ACI+)
|
||||||
[](https://docs.rs/crate/ratatui/)
|
[](https://docs.rs/crate/ratatui/)
|
||||||
[](https://deps.rs/repo/github/tui-rs-revival/ratatui)
|
Status](https://deps.rs/repo/github/ratatui-org/ratatui/status.svg?style=flat-square)](https://deps.rs/repo/github/ratatui-org/ratatui)
|
||||||
[](https://app.codecov.io/gh/tui-rs-revival/ratatui)
|
[](https://app.codecov.io/gh/ratatui-org/ratatui)
|
||||||
[](https://discord.gg/pMCEU9hNEj)
|
[](https://discord.gg/pMCEU9hNEj)
|
||||||
|
|
||||||
<!-- See RELEASE.md for instructions on creating the demo gif --->
|
<!-- See RELEASE.md for instructions on creating the demo gif --->
|
||||||
|
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>Table of Contents</summary>
|
<summary>Table of Contents</summary>
|
||||||
|
|
@ -90,7 +90,7 @@ The following example demonstrates the minimal amount of code necessary to setup
|
||||||
render "Hello World!". The full code for this example which contains a little more detail is in
|
render "Hello World!". The full code for this example which contains a little more detail is in
|
||||||
[hello_world.rs](./examples/hello_world.rs). For more guidance on how to create Ratatui apps, see
|
[hello_world.rs](./examples/hello_world.rs). For more guidance on how to create Ratatui apps, see
|
||||||
the [Docs](https://docs.rs/ratatui) and [Examples](#examples). There is also a starter template
|
the [Docs](https://docs.rs/ratatui) and [Examples](#examples). There is also a starter template
|
||||||
available at [rust-tui-template](https://github.com/tui-rs-revival/rust-tui-template).
|
available at [rust-tui-template](https://github.com/ratatui-org/rust-tui-template).
|
||||||
|
|
||||||
```rust
|
```rust
|
||||||
fn main() -> Result<(), Box<dyn Error>> {
|
fn main() -> Result<(), Box<dyn Error>> {
|
||||||
|
|
@ -215,7 +215,7 @@ be installed with `cargo install cargo-make`).
|
||||||
`tui::text::Text`
|
`tui::text::Text`
|
||||||
* [color-to-tui](https://github.com/uttarayan21/color-to-tui) — Parse hex colors to
|
* [color-to-tui](https://github.com/uttarayan21/color-to-tui) — Parse hex colors to
|
||||||
`tui::style::Color`
|
`tui::style::Color`
|
||||||
* [rust-tui-template](https://github.com/tui-rs-revival/rust-tui-template) — A template for bootstrapping a
|
* [rust-tui-template](https://github.com/ratatui-org/rust-tui-template) — A template for bootstrapping a
|
||||||
Rust TUI application with Tui-rs & crossterm
|
Rust TUI application with Tui-rs & crossterm
|
||||||
* [simple-tui-rs](https://github.com/pmsanford/simple-tui-rs) — A simple example tui-rs app
|
* [simple-tui-rs](https://github.com/pmsanford/simple-tui-rs) — A simple example tui-rs app
|
||||||
* [tui-builder](https://github.com/jkelleyrtp/tui-builder) — Batteries-included MVC framework for
|
* [tui-builder](https://github.com/jkelleyrtp/tui-builder) — Batteries-included MVC framework for
|
||||||
|
|
@ -241,7 +241,7 @@ be installed with `cargo install cargo-make`).
|
||||||
## Apps
|
## Apps
|
||||||
|
|
||||||
Check out the list of more than 50 [Apps using
|
Check out the list of more than 50 [Apps using
|
||||||
`Ratatui`](https://github.com/tui-rs-revival/ratatui/wiki/Apps-using-Ratatui)!
|
`Ratatui`](https://github.com/ratatui-org/ratatui/wiki/Apps-using-Ratatui)!
|
||||||
|
|
||||||
## Alternatives
|
## Alternatives
|
||||||
|
|
||||||
|
|
@ -251,12 +251,12 @@ to build text user interfaces in Rust.
|
||||||
## Contributors
|
## Contributors
|
||||||
|
|
||||||
[](https://github.com/tui-rs-revival/ratatui/graphs/contributors)
|
Contributors](https://contrib.rocks/image?repo=ratatui-org/ratatui)](https://github.com/ratatui-org/ratatui/graphs/contributors)
|
||||||
|
|
||||||
## Acknowledgments
|
## Acknowledgments
|
||||||
|
|
||||||
Special thanks to [**Pavel Fomchenkov**](https://github.com/nawok) for his work in designing **an
|
Special thanks to [**Pavel Fomchenkov**](https://github.com/nawok) for his work in designing **an
|
||||||
awesome logo** for the ratatui project and tui-rs-revival organization.
|
awesome logo** for the ratatui project and ratatui-org organization.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -26,5 +26,5 @@ actions](.github/workflows/cd.yml) and triggered by pushing a tag.
|
||||||
1. Commit and push the changes.
|
1. Commit and push the changes.
|
||||||
1. Create a new tag: `git tag -a v[X.Y.Z]`
|
1. Create a new tag: `git tag -a v[X.Y.Z]`
|
||||||
1. Push the tag: `git push --tags`
|
1. Push the tag: `git push --tags`
|
||||||
1. Wait for [Continuous Deployment](https://github.com/tui-rs-revival/ratatui/actions) workflow to
|
1. Wait for [Continuous Deployment](https://github.com/ratatui-org/ratatui/actions) workflow to
|
||||||
finish.
|
finish.
|
||||||
|
|
|
||||||
|
|
@ -46,7 +46,7 @@ filter_unconventional = true
|
||||||
split_commits = false
|
split_commits = false
|
||||||
# regex for preprocessing the commit messages
|
# regex for preprocessing the commit messages
|
||||||
commit_preprocessors = [
|
commit_preprocessors = [
|
||||||
{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/tui-rs-revival/ratatui/issues/${2}))" },
|
{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/ratatui-org/ratatui/issues/${2}))" },
|
||||||
{ pattern = '(better safe shared layout cache)', replace = "perf(layout): ${1}" },
|
{ pattern = '(better safe shared layout cache)', replace = "perf(layout): ${1}" },
|
||||||
{ pattern = '(Clarify README.md)', replace = "docs(readme): ${1}" },
|
{ pattern = '(Clarify README.md)', replace = "docs(readme): ${1}" },
|
||||||
{ pattern = '(Update README.md)', replace = "docs(readme): ${1}" },
|
{ pattern = '(Update README.md)', replace = "docs(readme): ${1}" },
|
||||||
|
|
|
||||||
|
|
@ -1,9 +1,9 @@
|
||||||
#![forbid(unsafe_code)]
|
#![forbid(unsafe_code)]
|
||||||
|
|
||||||
//! [ratatui](https://github.com/tui-rs-revival/ratatui) is a library used to build rich
|
//! [ratatui](https://github.com/ratatui-org/ratatui) is a library used to build rich
|
||||||
//! terminal users interfaces and dashboards.
|
//! terminal users interfaces and dashboards.
|
||||||
//!
|
//!
|
||||||
//! 
|
//! 
|
||||||
//!
|
//!
|
||||||
//! # Get started
|
//! # Get started
|
||||||
//!
|
//!
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue