Mirrors/ratatui
2
0
Fork 0
mirror of https://github.com/ratatui-org/ratatui synced 2024-11-25 22:20:31 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: Update links to templates repository 📚 (#810)

Browse source 
This PR updates links to the `templates` repository.
This commit is contained in:
Dheepak Krishnamurthy 2024-01-14 07:05:54 -05:00 committed by GitHub
parent 7a8af8da6b
commit 1746a61659
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -75,11 +75,8 @@ for more info.
The following example demonstrates the minimal amount of code necessary to setup a terminal and The following example demonstrates the minimal amount of code necessary to setup a terminal and
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]. For more guidance on different ways to structure your application see the [hello_world.rs]. For more guidance on different ways to structure your application see the
[Application Patterns] and [Hello World tutorial] sections in the [Ratatui Website] and the [Application Patterns] and [Hello World tutorial] sections in the [Ratatui Website] and the various
various [Examples]. There are also several starter templates available: [Examples]. There are also several starter templates in the [templates] repository.
- [template]
- [async-template] (book and template)
Every application built with `ratatui` needs to implement the following steps: Every application built with `ratatui` needs to implement the following steps:
@ -292,8 +289,7 @@ Running this example produces the following output:
[Handling Events]: https://ratatui.rs/concepts/event-handling/ [Handling Events]: https://ratatui.rs/concepts/event-handling/
[Layout]: https://ratatui.rs/how-to/layout/ [Layout]: https://ratatui.rs/how-to/layout/
[Styling Text]: https://ratatui.rs/how-to/render/style-text/ [Styling Text]: https://ratatui.rs/how-to/render/style-text/
[template]: https://github.com/ratatui-org/template [templates]: https://github.com/ratatui-org/templates
[async-template]: https://ratatui-org.github.io/async-template
[Examples]: https://github.com/ratatui-org/ratatui/tree/main/examples [Examples]: https://github.com/ratatui-org/ratatui/tree/main/examples
[Report a bug]: https://github.com/ratatui-org/ratatui/issues/new?labels=bug&projects=&template=bug_report.md [Report a bug]: https://github.com/ratatui-org/ratatui/issues/new?labels=bug&projects=&template=bug_report.md
[Request a Feature]: https://github.com/ratatui-org/ratatui/issues/new?labels=enhancement&projects=&template=feature_request.md [Request a Feature]: https://github.com/ratatui-org/ratatui/issues/new?labels=enhancement&projects=&template=feature_request.md
@ -404,8 +400,8 @@ be installed with `cargo install cargo-make`).
`ratatui::text::Text` `ratatui::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
`ratatui::style::Color` `ratatui::style::Color`
- [rust-tui-template](https://github.com/ratatui-org/rust-tui-template) — A template for - [templates](https://github.com/ratatui-org/templates) — Starter templates for
bootstrapping a Rust TUI application with Tui-rs & crossterm bootstrapping a Rust TUI application with Ratatui & crossterm
- [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
Tui-rs + Crossterm apps Tui-rs + Crossterm apps
- [tui-clap](https://github.com/kegesch/tui-clap-rs) — Use clap-rs together with Tui-rs - [tui-clap](https://github.com/kegesch/tui-clap-rs) — Use clap-rs together with Tui-rs

9
src/lib.rs
View file

@ -55,10 +55,8 @@
//! 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]. For more guidance on different ways to structure your application see the //! [hello_world.rs]. For more guidance on different ways to structure your application see the
//! [Application Patterns] and [Hello World tutorial] sections in the [Ratatui Website] and the //! [Application Patterns] and [Hello World tutorial] sections in the [Ratatui Website] and the
//! various [Examples]. There are also several starter templates available: //! various [Examples]. There are also several starter templates available in the [templates]
//! //! repository.
//! - [template]
//! - [async-template] (book and template)
//! //!
//! Every application built with `ratatui` needs to implement the following steps: //! Every application built with `ratatui` needs to implement the following steps:
//! //!
@ -289,8 +287,7 @@
//! [Handling Events]: https://ratatui.rs/concepts/event-handling/ //! [Handling Events]: https://ratatui.rs/concepts/event-handling/
//! [Layout]: https://ratatui.rs/how-to/layout/ //! [Layout]: https://ratatui.rs/how-to/layout/
//! [Styling Text]: https://ratatui.rs/how-to/render/style-text/ //! [Styling Text]: https://ratatui.rs/how-to/render/style-text/
//! [template]: https://github.com/ratatui-org/templates/tree/main/simple //! [templates]: https://github.com/ratatui-org/templates/
//! [async-template]: https://github.com/ratatui-org/templates/tree/main/async
//! [Examples]: https://github.com/ratatui-org/ratatui/tree/main/examples //! [Examples]: https://github.com/ratatui-org/ratatui/tree/main/examples
//! [Report a bug]: https://github.com/ratatui-org/ratatui/issues/new?labels=bug&projects=&template=bug_report.md //! [Report a bug]: https://github.com/ratatui-org/ratatui/issues/new?labels=bug&projects=&template=bug_report.md
//! [Request a Feature]: https://github.com/ratatui-org/ratatui/issues/new?labels=enhancement&projects=&template=feature_request.md //! [Request a Feature]: https://github.com/ratatui-org/ratatui/issues/new?labels=enhancement&projects=&template=feature_request.md