diff --git a/README.md b/README.md index afdb4f7..7877881 100644 --- a/README.md +++ b/README.md @@ -13,29 +13,84 @@ keyboard, when the right hand is shifted left by one, `nano` becomes `babi`. ### quitting babi -currently you can quit `babi` by using `^X` (or via `Esc` + `:q`). +currently you can quit `babi` by using ^X (or via esc + +:q). + +### key combinations + +these are all of the current key bindings in babi + +- ^S: save +- ^O: save as +- ^X: quit +- arrow keys: movement +- ^A / home: move to beginning of line +- ^E / end: move to end of line +- ^Y / pageup: move up one page +- ^V / pagedown: move down one page +- ^-left / ^-right: jump by word +- ^-home / ^-end: jump to beginning / end of file +- ^_: jump to line number +- selection: shift + ...: extend the current selection + - arrow keys + - home / end + - pageup / pagedown + - ^-left / ^-right + - ^-end / ^-home +- tab / shift-tab: indent or dedent current line (or + selection) +- ^K / ^U: cut and uncut the current line (or selection) +- M-u / M-U: undo / redo +- ^W: search +- ^\\: search and replace +- ^C: show the current position in the file +- ^-up / ^-down: scroll screen by a single line +- M-left / M-right: go to previous / next file +- ^Z: background +- esc: open the command mode + - :q: quit + - :w: write the file + - :wq: write the file and quit + - :sort: sort the file (or selection) + +in prompts (search, search replace, command): +- ^C: cancel +- ^K: cut to end +- ^R: reverse search + +### setting up syntax highlighting + +the syntax highlighting setup is a bit manual right now + +1. from a clone of babi, run `./bin/download-syntax` -- you will likely need + to install some additional packages to download them (`pip install cson`) +2. find a visual studio code theme, convert it to json (if it is not already + json) and put it at `~/.config/babi/theme.json` ## demos -not much works yet, here's a few things +most things work! here's a few screenshots ### file view -this opens the file, displays it, and can be edited in some ways and can save! -movement is currently enabled through the arrow keys, home + `^A`, end + `^E`, -and some key combinations are detected. unknown keys are displayed as errors -in the status bar. babi will scroll if the cursor goes off screen either from -resize events or from movement. babi can edit multiple files. babi has a -command mode (so you can quit it like vim `:q`!). +this opens the file, displays it, and can be edited and can save! unknown keys +are displayed as errors in the status bar. babi will scroll if the cursor +goes off screen either from resize events or from movement. babi can edit +multiple files. babi has a command mode (so you can quit it like vim +:q!). babi also support syntax highlighting -![](https://i.fluffy.cc/14Xc4hZg87CBnRBPGgFTKWbQFXFDmmwx.png) +![](https://i.fluffy.cc/5WFZBJ4mWs7wtThD9strQnGlJqw4Z9KS.png) -![](https://i.fluffy.cc/wLvTm86lbLnjBgF0WtVQpsxW90QbJwz5.png) +![](https://i.fluffy.cc/qrNhgCK34qKQ6tw4GHLSGs4984Qqnqh7.png) -![](https://i.fluffy.cc/RhVmwb8MQkZZbC399GtV99RSH3SB6FTZ.png) +![](https://i.fluffy.cc/DKlkjnZ4tgfnxH7cxjnLcB7GkBVdW35v.png) -![](https://i.fluffy.cc/dKDd9rBm7hsXVsgZfvXM63gC8QQxJdhk.png) +![](https://i.fluffy.cc/VqHWHfWNW73sppZlHv0C4lw63TVczZfZ.png) -![](https://i.fluffy.cc/PQq1sqpcx59tWNFGF4nThQH1gSVHjVCn.png) +![](https://i.fluffy.cc/p8lv61TCql1MJfpBDqbNPWPf27lmGWFN.png) -![](https://i.fluffy.cc/KfGg7NhNTTH5X4ZsxdsMt72RVg5nR79H.png) +![](https://i.fluffy.cc/ZH5sswB4FSbpW8FfcXL1KZWdJnjxRkbW.png) + +![](https://i.fluffy.cc/Rw8nZKFC3R36mNrV01fL2gk4rfwWn7wX.png) + +![](https://i.fluffy.cc/FSD92ZVN4xcMFPv1V7gc0Xzk8TCQTgdg.png) diff --git a/SCREENS.md b/SCREENS.md index 6b17b7d..bfabd6c 100644 --- a/SCREENS.md +++ b/SCREENS.md @@ -53,3 +53,24 @@ see the progress of babi over time - babi can be quit using `:q` and can save using `:w` ![](https://i.fluffy.cc/KfGg7NhNTTH5X4ZsxdsMt72RVg5nR79H.png) + +### 2020-03-14 + +- a lot of stuff has changed, there's now syntax highlighting and other things +- sorry I haven't updated in a while + +![](https://i.fluffy.cc/5WFZBJ4mWs7wtThD9strQnGlJqw4Z9KS.png) + +![](https://i.fluffy.cc/qrNhgCK34qKQ6tw4GHLSGs4984Qqnqh7.png) + +![](https://i.fluffy.cc/DKlkjnZ4tgfnxH7cxjnLcB7GkBVdW35v.png) + +![](https://i.fluffy.cc/VqHWHfWNW73sppZlHv0C4lw63TVczZfZ.png) + +![](https://i.fluffy.cc/p8lv61TCql1MJfpBDqbNPWPf27lmGWFN.png) + +![](https://i.fluffy.cc/ZH5sswB4FSbpW8FfcXL1KZWdJnjxRkbW.png) + +![](https://i.fluffy.cc/Rw8nZKFC3R36mNrV01fL2gk4rfwWn7wX.png) + +![](https://i.fluffy.cc/FSD92ZVN4xcMFPv1V7gc0Xzk8TCQTgdg.png)