From 51cf9de63340bf5537829289fdc2102228d7a858 Mon Sep 17 00:00:00 2001 From: Josh McKinney Date: Wed, 4 Sep 2024 11:25:46 -0700 Subject: [PATCH] Fix simple README --- simple/README.md | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/simple/README.md b/simple/README.md index a667497..3b5cf10 100644 --- a/simple/README.md +++ b/simple/README.md @@ -5,20 +5,13 @@ The simple template will create the following project structure: ```text src/ ├── app.rs -> holds the state and application logic -├── event.rs -> handles the terminal events (key press, mouse click, resize, etc.) ├── main.rs -> entry-point ``` ## Design choices -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 have a small `App` struct that has a main loop that calls methods to handle events and draw the -ui. +ui. The app can be quit by pressing any of Q/Esc/Ctrl+C. -Events are read on a secondary thread and collated into a single mpsc channel. This allows a tick -event to be interspersed with other events like keyboard and mouse. The Tick event is a useful place -to perform updates to animations or to do external polling. - -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.