README.md

Conway's Game of Life TUI in Rust

Usage

installation methods

• cargo install cgol-tui
• cargo install --locked --git "https://github.com/JeromeSchmied/cgol-tui-rs"
• clone the repo and run cargo install --locked --path .

after

[curl "https://conwaylife.com/patterns/<pattern>.cells" | ] cgol-tui [[-],<pattern>.cells,...] eg.:

• cgol-tui
• curl https://conwaylife.com/patterns/fx153.cells | cgol-tui - the - stands for stdin
• cgol-tui my_own_pattern.cells fx153.cells

Script

there is a fish script provided under scripts for viewing patterns from conwaylife.com
usage: pattern.fish <PATTERN_NAME> [OPTIONS]
PATTERN_NAME: either a name of a pattern, or nothing to list all patterns
OPTIONS: -d, --download download to /tmp

needed tools

• fish: shell
• curl: download
• ripgrep: only for listing all patterns

Sample

Todos

• initial tui support
• renaming on gh
• error handling
• publishing to crates.io
• changing to Canvas for rendering viewer block
• the ability to parse .cells files, from conwaylife.com
• display the names of patterns

Acknowledgements

• The core of this app is adapted from the Rust-Wasm tutorial.
• main dependencies:
  • ratatui: ui
  • crossterm: ratatui backend

License

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.