refactor: revamp the simple template (#87)

* docs(readme): revamp the simple template docs

* docs(simple): add more comments and fix links

* chore(simple): generate the simple template

* docs(simple): update comments

* refactor(simple): rename draw to render

Author: orhun

simple-generated/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "simple-generated"
 version = "0.1.0"
-authors = ["Josh McKinney <[email protected].com>"]
+authors = ["Orhun Parmaksız <orhunparmaksiz@gmail.com>"]
 license = "MIT"
 edition = "2021"
 

simple-generated/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) Josh McKinney <[email protected].com>
+Copyright (c) Orhun Parmaksız <orhunparmaksiz@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

simple-generated/README.md

@@ -1,13 +1,13 @@
 # simple-generated
 
-This is a [Ratatui] app generated by the [Simple template].
+This is a [Ratatui] app generated by the [Simple Template].
 
 [Ratatui]: https://ratatui.rs
 [Simple Template]: https://github.com/ratatui/templates/tree/main/simple
 
 ## License
 
-Copyright (c) Josh McKinney <[email protected].com>
+Copyright (c) Orhun Parmaksız <orhunparmaksiz@gmail.com>
 
 This project is licensed under the MIT license ([LICENSE] or <http://opensource.org/licenses/MIT>)
 

simple-generated/src/app.rs

@@ -7,6 +7,7 @@ use ratatui::{
     DefaultTerminal, Frame,
 };
 
+/// The main application which holds the state and logic of the application.
 #[derive(Debug, Default)]
 pub struct App {
     /// Is the application running?
@@ -23,7 +24,7 @@ impl App {
     pub fn run(mut self, mut terminal: DefaultTerminal) -> Result<()> {
         self.running = true;
         while self.running {
-            terminal.draw(|frame| self.draw(frame))?;
+            terminal.draw(|frame| self.render(frame))?;
             self.handle_crossterm_events()?;
         }
         Ok(())
@@ -32,9 +33,10 @@ impl App {
     /// Renders the user interface.
     ///
     /// This is where you add new widgets. See the following resources for more information:
+    ///
     /// - <https://docs.rs/ratatui/latest/ratatui/widgets/index.html>
-    /// - <https://github.com/ratatui/ratatui/tree/master/examples>
-    fn draw(&mut self, frame: &mut Frame) {
+    /// - <https://github.com/ratatui/ratatui/tree/main/ratatui-widgets/examples>
+    fn render(&mut self, frame: &mut Frame) {
         let title = Line::from("Ratatui Simple Template")
             .bold()
             .blue()

simple/README.md

@@ -1,17 +1,17 @@
-# Ratatui Simple template
+# Ratatui Simple Template
 
 The simple template will create the following project structure:
 
 ```text
 src/
 ├── app.rs     -> holds the state and application logic
-├── main.rs    -> entry-point
+└── main.rs    -> entry-point
 ```
 
 ## Design choices
 
 We have a small `App` struct that has a main loop that calls methods to handle events and draw the
-ui. The app can be quit by pressing any of Q/Esc/Ctrl+C.
+UI. The app can be quit by pressing any of Q/Esc/Ctrl+C.
 
-We use [color-eyre](https://docs.rs/color-eyre/latest/color_eyre/) for simplifying any errors that
-need to be reported to the console.
+We use [color-eyre](https://docs.rs/color-eyre) for simplifying any errors that need to be reported
+to the console.

simple/template/README.md

@@ -1,6 +1,6 @@
 # {{project-name}}
 
-This is a [Ratatui] app generated by the [Simple template].
+This is a [Ratatui] app generated by the [Simple Template].
 
 [Ratatui]: https://ratatui.rs
 [Simple Template]: https://github.com/ratatui/templates/tree/main/simple

simple/template/src/app.rs

@@ -7,6 +7,7 @@ use ratatui::{
     DefaultTerminal, Frame,
 };
 
+/// The main application which holds the state and logic of the application.
 #[derive(Debug, Default)]
 pub struct App {
     /// Is the application running?
@@ -23,7 +24,7 @@ impl App {
     pub fn run(mut self, mut terminal: DefaultTerminal) -> Result<()> {
         self.running = true;
         while self.running {
-            terminal.draw(|frame| self.draw(frame))?;
+            terminal.draw(|frame| self.render(frame))?;
             self.handle_crossterm_events()?;
         }
         Ok(())
@@ -32,9 +33,10 @@ impl App {
     /// Renders the user interface.
     ///
     /// This is where you add new widgets. See the following resources for more information:
+    ///
     /// - <https://docs.rs/ratatui/latest/ratatui/widgets/index.html>
-    /// - <https://github.com/ratatui/ratatui/tree/master/examples>
-    fn draw(&mut self, frame: &mut Frame) {
+    /// - <https://github.com/ratatui/ratatui/tree/main/ratatui-widgets/examples>
+    fn render(&mut self, frame: &mut Frame) {
         let title = Line::from("Ratatui Simple Template")
             .bold()
             .blue()