aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHampusM <hampus@hampusmat.com>2022-06-12 16:28:28 +0200
committerHampusM <hampus@hampusmat.com>2022-06-13 17:57:02 +0200
commit7399afb9ec9776dfa131dbf27ed6fb7524aec81b (patch)
tree95a52e9550fe153ceb25cd8f18a1d22d80aa7982
parent9cc1b8e5d8fa7b70ac4d36b61b7364032b389b80 (diff)
docs: add features & usage to readme
-rw-r--r--README.md45
1 files changed, 41 insertions, 4 deletions
diff --git a/README.md b/README.md
index 3df9e33..c3adeaf 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,47 @@
-# About
-This is a c++ Linux CLI implementation of John Conway's game of life.
+## About
+
+A c++ Linux CLI implementation of John Conway's game of life.
+
+## Features
+
+- Vim-like key bindings
+- Open [RLE](https://conwaylife.com/wiki/Run_Length_Encoded) files
+- Change generation speed
+- Generation stepping
+- Pause & unpause
+
+## Usage
+
+#### Key bindings (normal mode)
+
+`h`, `j`, `k` & `l` to move left, down, up & right, respectively.
+
+`q` to quit.
+
+`i` to insert a cell.
+
+`x` to delete a cell.
+
+`p` to pause and unpause.
+
+`s` to step a generation.
+
+`+` & `-` to to increment & decrement the generation speed, respectively.
+
+`:` to enter command mode.
+
+#### Commands
+
+Commands that can be run in command mode.
+
+`open (PATH)` to open a [RLE](https://conwaylife.com/wiki/Run_Length_Encoded) file.
+
+## Todo
-# Todo
- Dynamic terminal window size. Redraw everything when the window size changes
-# Good to have links
+## Good to have links
+
[Original Scientific American article](https://web.stanford.edu/class/sts145/Library/life.pdf)
[John Conway's Game of Life](https://playgameoflife.com)