diff --git a/README.md b/README.md index 5db0285..e8f5810 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ This repository contains templates for bootstrapping a Rust [TUI](https://en.wikipedia.org/wiki/Text-based_user_interface) application with -[`Ratatui`](https://github.com/ratatui-org/ratatui) & +[`Ratatui`](https://github.com/ratatui/ratatui) & [`crossterm`](https://github.com/crossterm-rs/crossterm). ## Getting Started @@ -16,7 +16,7 @@ This repository contains templates for bootstrapping a Rust 2. Create a new app based on this repository: ```shell - cargo generate ratatui-org/templates + cargo generate ratatui/templates ``` 3. Choose one of the following templates: diff --git a/component/README.md b/component/README.md index 0e79627..29533af 100644 --- a/component/README.md +++ b/component/README.md @@ -8,7 +8,7 @@ You can start by using `cargo-generate`: ```shell cargo install cargo-generate -cargo generate ratatui-org/templates component --name ratatui-hello-world +cargo generate ratatui/templates component --name ratatui-hello-world cd ratatui-hello-world ``` @@ -23,19 +23,19 @@ cd ratatui-hello-world - [human-panic](https://github.com/rust-cli/human-panic) - Clap for command line argument parsing - `Component` trait with - [`Home`](https://github.com/ratatui-org/async-template/blob/main/template/src/components/home.rs) + [`Home`](https://github.com/ratatui/async-template/blob/main/template/src/components/home.rs) and - [`Fps`](https://github.com/ratatui-org/async-template/blob/main/template/src/components/fps.rs) + [`Fps`](https://github.com/ratatui/async-template/blob/main/template/src/components/fps.rs) components as examples ## Advanced Usage You can also use a -[`template.toml`](https://github.com/ratatui-org/async-template/blob/main/.github/workflows/template.toml) +[`template.toml`](https://github.com/ratatui/async-template/blob/main/.github/workflows/template.toml) file to skip the prompts: ```bash -$ cargo generate --git https://github.com/ratatui-org/async-template --template-values-file .github/workflows/template.toml --name ratatui-hello-world +$ cargo generate --git https://github.com/ratatui/async-template --template-values-file .github/workflows/template.toml --name ratatui-hello-world # OR generate from local clone $ cargo generate --path . --template-values-file .github/workflows/template.toml --name ratatui-hello-world ``` @@ -104,7 +104,7 @@ Data directory: /Users/kd/gitrepos/async-template/ratatui-hello-world/.data ## Documentation Read documentation on design decisions in the template here: - + ## Counter + Text Input Demo @@ -113,7 +113,7 @@ run a demo without using `cargo generate`, you can run the counter + text input the instructions below: ```bash -git clone https://github.com/ratatui-org/async-template +git clone https://github.com/ratatui/async-template cd async-template cd ratatui-counter # counter + text input demo @@ -128,4 +128,4 @@ cargo run You should see a demo like this: -![counter demo](https://github.com/ratatui-org/async-template/assets/1813121/057a0fe9-9f6d-4f8c-963c-ca2725721bdd) +![counter demo](https://github.com/ratatui/async-template/assets/1813121/057a0fe9-9f6d-4f8c-963c-ca2725721bdd) diff --git a/simple-async-generated/src/ui.rs b/simple-async-generated/src/ui.rs index bbe2773..c5135f4 100644 --- a/simple-async-generated/src/ui.rs +++ b/simple-async-generated/src/ui.rs @@ -12,7 +12,7 @@ pub fn render(app: &mut App, frame: &mut Frame) { // This is where you add new widgets. // See the following resources: // - https://docs.rs/ratatui/latest/ratatui/widgets/index.html - // - https://github.com/ratatui-org/ratatui/tree/master/examples + // - https://github.com/ratatui/ratatui/tree/master/examples frame.render_widget( Paragraph::new(format!( "This is a tui template.\n\ diff --git a/simple-async/src/ui.rs b/simple-async/src/ui.rs index bbe2773..c5135f4 100644 --- a/simple-async/src/ui.rs +++ b/simple-async/src/ui.rs @@ -12,7 +12,7 @@ pub fn render(app: &mut App, frame: &mut Frame) { // This is where you add new widgets. // See the following resources: // - https://docs.rs/ratatui/latest/ratatui/widgets/index.html - // - https://github.com/ratatui-org/ratatui/tree/master/examples + // - https://github.com/ratatui/ratatui/tree/master/examples frame.render_widget( Paragraph::new(format!( "This is a tui template.\n\ diff --git a/simple-generated/src/ui.rs b/simple-generated/src/ui.rs index bbe2773..c5135f4 100644 --- a/simple-generated/src/ui.rs +++ b/simple-generated/src/ui.rs @@ -12,7 +12,7 @@ pub fn render(app: &mut App, frame: &mut Frame) { // This is where you add new widgets. // See the following resources: // - https://docs.rs/ratatui/latest/ratatui/widgets/index.html - // - https://github.com/ratatui-org/ratatui/tree/master/examples + // - https://github.com/ratatui/ratatui/tree/master/examples frame.render_widget( Paragraph::new(format!( "This is a tui template.\n\ diff --git a/simple/src/ui.rs b/simple/src/ui.rs index bbe2773..c5135f4 100644 --- a/simple/src/ui.rs +++ b/simple/src/ui.rs @@ -12,7 +12,7 @@ pub fn render(app: &mut App, frame: &mut Frame) { // This is where you add new widgets. // See the following resources: // - https://docs.rs/ratatui/latest/ratatui/widgets/index.html - // - https://github.com/ratatui-org/ratatui/tree/master/examples + // - https://github.com/ratatui/ratatui/tree/master/examples frame.render_widget( Paragraph::new(format!( "This is a tui template.\n\