golcli

README

🧬 golcli

A basic CLI implementation of Conway's Game of Life.

---

🌱 Setup

Download and compile from sources:

go get github.com/branogarbo/golcli

Install just the binary with Go:

go install github.com/branogarbo/golcli@latest

Or get the pre-compiled binaries for your platform on the releases page

🌳 CLI usage

golcli

A basic CLI implementation of Conway's Game of Life.

Usage:
  golcli [flags]
  golcli [command]

Examples:
golcli -c 100 -i 20 ./pattern.txt

Available Commands:
  build       Creates a build file from a pattern file.
  help        Help about any command
  run         Runs a build file.

Flags:
  -c, --count int          The number of frames displayed before exiting (-1 : infinite loop) (default -1)
  -d, --dead-char string   The character(s) that represent a dead cell (default "██")
  -H, --height int         The height of the frames (default 30)
  -h, --help               help for golcli
  -i, --interval int       The number of milliseconds between frames (default 50)
  -l, --live-char string   The character(s) that represent a live cell (default "  ")
  -x, --pattern-x int      The x offset of the initial pattern (default 12)
  -y, --pattern-y int      The y offset of the initial pattern (default 8)
  -W, --width int          The width of the frames (default 40)

Use "golcli [command] --help" for more information about a command.

build:

Creates a build file from a pattern file.

Usage:
  golcli build [flags]

Examples:
golcli build -W 70 -c 400 pattern.txt builds/pattern

Flags:
  -c, --count int       The number of frames displayed before exiting (default 500)
  -H, --height int      The height of the frames (default 30)
  -h, --help            help for build
  -x, --pattern-x int   The x offset of the initial pattern (default 12)
  -y, --pattern-y int   The y offset of the initial pattern (default 8)
  -W, --width int       The width of the frames (default 40)

run:

Runs a build file.

Usage:
  golcli run [flags]

Examples:
golcli run -l "##" -d ".." -i 200 buildFiles/pattern

Flags:
  -d, --dead-char string   The character(s) that represent a dead cell (default "██")
  -h, --help               help for run
  -i, --interval int       The number of milliseconds between frames (default 50)
  -l, --live-char string   The character(s) that represent a live cell (default "  ")

Documentation

Overview

Copyright © 2021 Brian Longmore branodev@gmail.com

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.