From ca6d8f27f5d386b990630d40da68aeeae9796a55 Mon Sep 17 00:00:00 2001 From: Jonathan Lamothe Date: Thu, 22 Aug 2024 19:32:04 -0400 Subject: [PATCH] added details to README.md --- README.md | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c75e398..3a2100e 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,30 @@ You should have received a copy of the GNU Affero General Public License along with this program. If not, see . -## Important Note +## Executive Summary -Ths program is not yet ready for release and should be considered -subject to change at any time. +This is a TUI abacus simulator. It is a completely pointless program. I +made it solely for the sake of the absurdity. + +## Installation + +This program is written in [Haskell](https://haskell.org) using the +Stack package manager. The easiest way to install it is by first +installing [GHCup](https://www.haskell.org/ghcup/), and then from +within the project directory, run the command: `stack install` + +You should then be able to run it by simply typing `abacus` on the +command line. There are currently no command-line options. + +## Keys + +- C-c/q: Quit the program +- up/k: move the rung selector up +- down/j: move the rung selector down +- PgUp/K/S-up: select the top rung +- PgDn/J/S-down: select the bottom rung +- left/h: slide a bead to the left +- right/l: slide a bead to the right +- Home/H/S-left: move the entire rung to the left +- End/L/S-right: move the entire rung to the right +- r: reset the abacus