From d35d17d5f8e7199d4e5b87de888a401d873b9251 Mon Sep 17 00:00:00 2001 From: sloum Date: Fri, 25 Jun 2021 14:55:09 -0700 Subject: [PATCH] Updates readme to include hot keys --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 6634020..511ad2d 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,31 @@ At present there is no keyboard input. This is on the TODO list and should get a Most of the keys can be figured out if you don't know what they are already. I will mention that the enter key will add the currently typed in number to the top of the stack. If you have a number typed in, but have not hit enter, and you use a non-numeric/non-enter key (+, swap, sqrt, etc) the number will automatically be added to the top of the stack before the function is run. +### Hot Keys + +| Key(s) | Effect | +|-------------|-------------------------------------------------------| +| Number Key (`0`-`9`) | Enter the given number | +| `.` | Enter a decimal point to the current input value | +| `Backspace` | Delete a character from the current input value | +| `Enter` | Place the current input value on the top of the stack | +| `Tab` | Toggle the stack view open/closed | +| `Ctrl-q` | Exit gnums | +| `+` | Add | +| `-` | Subtract | +| `*` | Multiply | +| `/` | Divide | +| `!` | Invert the top stack value's sign (+/-) | +| `^` | Exponent | +| `f` | Floor | +| `c` | Ceiling | +| `r` | Round | +| `q` | Square root | +| `o` | Over | +| `s` | Swap | +| `d` | Drop | +| `u` | Dup | + ## Dependencies - Go >= 1.16