From 66020ce5131cee894e28ba4fb7c862b0277d6764 Mon Sep 17 00:00:00 2001 From: Jeromos Kovacs Date: Sun, 29 Sep 2024 20:40:08 +0200 Subject: [PATCH] docs(README): updated --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 74daccf..cb52315 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# Conway's Game of Life tui in Rust +# Conway's Game of Life TUI in Rust ## Usage -install with either +installation methods - `cargo install cgol-tui` - `cargo install --locked --git "https://github.com/JeromeSchmied/cgol-tui-rs"` @@ -15,7 +15,6 @@ eg.: - `cgol-tui` - `curl https://conwaylife.com/patterns/fx153.cells | cgol-tui -` the `-` stands for `stdin` -- `cgol-tui my_own_pattern.cells` - `cgol-tui my_own_pattern.cells fx153.cells` ## Sample @@ -30,13 +29,14 @@ eg.: - [x] publishing to crates.io - [x] changing to `Canvas` for rendering viewer block - [x] the ability to parse `.cells` files, from [conwaylife.com](https://conwaylife.com/patterns) +- [ ] display the names of patterns ## Acknowledgements - The core of this app is adapted from the [Rust-Wasm tutorial](https://rustwasm.github.io/docs/book/). - main dependencies: - - ratatui: ui - - crossterm: ratatui backend + - [ratatui](https://ratatui.rs): ui + - [crossterm](https://github.com/crossterm-rs/crossterm): ratatui backend ## License