added details to README.md
This commit is contained in:
parent
52c7634121
commit
ca6d8f27f5
29
README.md
29
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
|
License along with this program. If not, see
|
||||||
<https://www.gnu.org/licenses/>.
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
## Important Note
|
## Executive Summary
|
||||||
|
|
||||||
Ths program is not yet ready for release and should be considered
|
This is a TUI abacus simulator. It is a completely pointless program. I
|
||||||
subject to change at any time.
|
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
|
||||||
|
|
Loading…
Reference in New Issue
Block a user