Skip to content

Commit

Permalink
docs(README): updated
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeromos Kovacs committed Sep 29, 2024
1 parent efc1e74 commit 66020ce
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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"`
Expand All @@ -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
Expand All @@ -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

Expand Down

0 comments on commit 66020ce

Please sign in to comment.