Move template to subtemplate named simple

ratatui · Dec 15, 2023 · a119009 · a119009
1 parent 4e44b39
commit a119009
Show file tree

Hide file tree

Showing 13 changed files with 16 additions and 295 deletions.
diff --git a/.markdownlint.toml b/.markdownlint.toml
@@ -0,0 +1 @@
+line-length = { line_length = 100 }
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/README.md b/README.md
@@ -1,12 +1,13 @@
-# `ratatui-template` 🧀
+# Ratatui templates 🧀
 
-A template for bootstrapping a Rust [**TUI**](https://en.wikipedia.org/wiki/Text-based_user_interface) application with [`Ratatui`](https://github.com/ratatui-org/ratatui) & [`crossterm`](https://github.com/crossterm-rs/crossterm).
-
-<img src="https://raw.githubusercontent.com/ratatui-org/ratatui/b33c878808c4c40591d7a2d9f9d94d6fee95a96f/examples/demo2.gif" width="600">
+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) &
+[`crossterm`](https://github.com/crossterm-rs/crossterm).
 
 ## Project structure
 
-```
+```text
 src/
 ├── app.rs     -> holds the state and application logic
 ├── event.rs   -> handles the terminal events (key press, mouse click, resize, etc.)
@@ -21,15 +22,15 @@ src/
 
 1. Install [`cargo-generate`](https://github.com/cargo-generate/cargo-generate#installation)
 
-```sh
-cargo install cargo-generate
-```
+   ```shell
+   cargo install cargo-generate
+   ```
 
-2. Clone this repository via `cargo-generate`:
+2. Create a new app based on this repository:
 
-```sh
-cargo generate --git https://github.com/ratatui-org/ratatui-template --name <project-name>
-```
+   ```shell
+   cargo generate ratatui-org/ratatui-template simple
+   ```
 
 ## See also
 

diff --git a/cargo-generate.toml b/cargo-generate.toml
@@ -1,4 +1,4 @@
 # configuration for https://cargo-generate.github.io/cargo-generate/
 
 [template]
-ignore = ["README.md", ".github/"]
+sub_templates = ["simple"]
diff --git a/.gitignore → simple/.gitignore b/.gitignore → simple/.gitignore
diff --git a/Cargo.toml → simple/Cargo.toml b/Cargo.toml → simple/Cargo.toml
@@ -6,5 +6,5 @@ license = "MIT"
 edition = "2021"
 
 [dependencies]
-crossterm = "0.26.1"
+crossterm = "0.27.0"
 ratatui = "0.24.0"
diff --git a/src/app.rs → simple/src/app.rs b/src/app.rs → simple/src/app.rs
diff --git a/src/event.rs → simple/src/event.rs b/src/event.rs → simple/src/event.rs
diff --git a/src/handler.rs → simple/src/handler.rs b/src/handler.rs → simple/src/handler.rs
diff --git a/src/lib.rs → simple/src/lib.rs b/src/lib.rs → simple/src/lib.rs
diff --git a/src/main.rs → simple/src/main.rs b/src/main.rs → simple/src/main.rs
diff --git a/src/tui.rs → simple/src/tui.rs b/src/tui.rs → simple/src/tui.rs
diff --git a/src/ui.rs → simple/src/ui.rs b/src/ui.rs → simple/src/ui.rs