Skip to content

Commit

Permalink
readme: Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
johannes-wolf committed Apr 19, 2024
1 parent 876af1d commit b3b10e6
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ An RPN interface for the TI Nspire CX

## Install

Use the latest build from the GitHub actions and put it under `MyWidgets` on your nspire CX.
Releases <= alpha-20 are of an old version of rpn-spire.
Use the latest build from the *GitHub actions* and put it under `MyWidgets` on your nspire CX.

## Build

Expand All @@ -27,7 +26,7 @@ Feel free to submit PRs or ask for features and fixes 😊.

The input field of rpnspire supports autocompletion for functions, variables and units. To trigger completion,
press <kbd>tab</kbd>. Completion uses characters left to the cursor as compeltions prefix. Typing `so<tab>` will
present you the first entry of a list of completion candidates starting with `so`. Pressing <kbd>tab</kbd> multiple times loops through all candidates. To accept a completion press hit <kbd>enter</kbd>. Completions are sorted by use (see [config/stats.lua](config/stats.lua)).
present you the first entry of a list of completion candidates starting with `so`. Pressing <kbd>tab</kbd> multiple times loops through all candidates. To accept a completion press hit <kbd>enter</kbd>. Completions are sorted by use (see [config/stats.lua](config/stats.lua)). Typing with the completion pop-up open, further filters the candidates.

### RPN-Mode

Expand Down Expand Up @@ -55,11 +54,11 @@ RPNspire features a matrix editor to write and edit matrixes.

## Settings

See [config/config.lua](config/config.lua).
See [config/config.lua](config/config.lua), to adjust defaults.

## Bindings

See [config/bindings.lua](config/bindings.lua).
See [config/bindings.lua](config/bindings.lua), to configure your own bindings.

rpnspire uses key-sequences for its bindings. <kbd>.</kbd><kbd>e</kbd> means: Press `.` and then press `e`.
The current sequence of keys pressed (that are part of a binding) is displayed by a dialog at the
Expand All @@ -76,8 +75,10 @@ top of the screen.
| <kbd>down</kbd> | Swap stack 1 & 2 |
| <kbd>enter</kbd> | Submit input; if empty: dup 1 |
| <kbd>tab</kbd> | Start completion for current input |
| <kbd>.</kbd><kbd>left</kbd> | Go to beginning |
| <kbd>.</kbd><kbd>right</kbd> | Go to end |
| <kbd>.</kbd><kbd>left</kbd> | Roll up beginning |
| <kbd>.</kbd><kbd>right</kbd> | Roll down end |

| Key | Function |
|------------------------------|---------------------------------------------------------|
| <kbd>.</kbd><kbd>=</kbd> | Store Y in X |
| <kbd>.</kbd><kbd>+-*/^</kbd> | Push dot operator |
Expand All @@ -92,6 +93,8 @@ top of the screen.
| <kbd>.</kbd><kbd>a</kbd> | Display apps/tool |
| <kbd>.</kbd><kbd>b</kbd> | Display bindings |
| <kbd>.</kbd><kbd>m</kbd> | Open matrix editor |
| <kbd>.</kbd><kbd>return</kbd> | Show command palette editor |


### Stack
| Key | Function |
Expand Down

0 comments on commit b3b10e6

Please sign in to comment.