diff options
| author | Kyle Sutherland-Cash <kyle.sutherland-cash@ensoft.co.uk> | 2020-11-21 14:55:49 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-21 15:55:49 +0100 |
| commit | 11e72b3d6b97c117633d73c46cd7c91b549c3e8e (patch) | |
| tree | a29bcbbf4d39267ceb6720aaf25ea0f841606e1a /README.md | |
| parent | 429e415ecca4948563d6e5b81f7270a98963f6bb (diff) | |
feat(ux): add a command mode (#42)
* Move the input loop into a separate module
* Proof of concept implementation of command mode
* Update readme to reflect command mode
* Have Esc exit command mode
* Update tests to use command mode and make it transient by default
* Some merge fixes
* fix(tests): add missing COMMAND_TOGGLE and fix false positive test
* style(format): make rustfmt happy
* Update readme to describe command mode
Co-authored-by: Aram Drevekenin <aram@poor.dev>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 36 |
1 files changed, 23 insertions, 13 deletions
@@ -32,19 +32,29 @@ If you're interested, watch this space or better yet - get involved! (note that right now Mosaic only supports linux and maybe mac) -Some temporary controls (these will be changed to something more convenient when the project matures a little): - * ctrl-n - split focused pane vertically - * ctrl-b - split focused pane horizontally - * ctrl-m - split largest terminal on screen (vertically or horizontally) - * ctrl-j - resize focused pane down - * ctrl-k - resize focused pane up - * ctrl-h - resize focused pane left - * ctrl-l - resize focused pane right - * ctrl-p - move focus to next pane - * ctrl-PgUp - scroll up in focused pane - * ctrl-PgDown - scroll down in focused pane - * ctrl-x - close focused pane - * ctrl-q - quit Mosaic +mosaic has three modes, which are a bit like vim or tmux: + * Normal mode - allows you to enter text, input will be sent through to stdin on the pane you're typing in + * Command mode - input is interpreted as commands to control mosaic. This comes in two variants: + * Temporary - once a single valid command has been parsed, returns to normal mode (e.g. quickly opening a new pane and start typing) + * Permanent - remain in command mode until you issue the exit command mode command + +The keys and behavior will update when the project matures a bit, but for now: + * ctrl-g to cycle between modes (normal mode -> temporary command mode -> permanent command mode -> normal mode) + * Esc - exit command mode (any) and return to normal mode + +In command mode: + * n - split focused pane vertically + * b - split focused pane horizontally + * m - split largest terminal on screen (vertically or horizontally) + * j - resize focused pane down + * k - resize focused pane up + * h - resize focused pane left + * l - resize focused pane right + * p - move focus to next pane + * PgUp - scroll up in focused pane + * PgDown - scroll down in focused pane + * x - close focused pane + * q - quit Mosaic # What is the current status of the project? |