diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..a656032 --- /dev/null +++ b/README.md | |||
| @@ -0,0 +1,75 @@ | |||
| 1 | ES | ||
| 2 | ==== | ||
| 3 | |||
| 4 | ES is EMACS but without MACros. This is a shitty little editor, should build with who-knows-which | ||
| 5 | zig master version. | ||
| 6 | |||
| 7 | This doesn't implement windowing as I don't think I can beat tmux for that. It is expected that | ||
| 8 | `C-c` will be used for the tmux prefix key so it is not being assigned to anything in ES. | ||
| 9 | |||
| 10 | I have attached a tmux config in `dot-tmux.conf`, symlink `~/.config/tmux/tmux.conf` to it or base | ||
| 11 | your own config on it, whatever floats your boat. | ||
| 12 | |||
| 13 | Currently you have to guess the keybindings from `src/KeyMap.zig` + tmux, maybe at some point I will | ||
| 14 | create a built in help screen. | ||
| 15 | |||
| 16 | Building | ||
| 17 | ---------- | ||
| 18 | |||
| 19 | Building this is very simple | ||
| 20 | |||
| 21 | ```sh | ||
| 22 | $ zig build -Doptimize=ReleaseSafe | ||
| 23 | ``` | ||
| 24 | |||
| 25 | To run it without installing: | ||
| 26 | |||
| 27 | ```sh | ||
| 28 | $ zig build -Doptimize=ReleaseSafe run | ||
| 29 | ``` | ||
| 30 | |||
| 31 | To install it (feel free to replace `~/.local` with any other prefix you want to use). | ||
| 32 | |||
| 33 | ```sh | ||
| 34 | $ zig build -Doptimize=ReleaseSafe -p ~/.local | ||
| 35 | ``` | ||
| 36 | |||
| 37 | Configuration | ||
| 38 | --------------- | ||
| 39 | |||
| 40 | There is a very bare-bones configuration available. An example with default values is installed to | ||
| 41 | `$PREFIX/share/arkta/es/es.ini`, copy it to `~/.config/arkta/es/es.ini` (actually any | ||
| 42 | `$XDG_CONFIG_HOME`, `$XDG_CONFIG_DIRS`, &c are supported). | ||
| 43 | |||
| 44 | <table> | ||
| 45 | <caption>Configuration cheatsheet</caption> | ||
| 46 | <thead> | ||
| 47 | <tr> | ||
| 48 | <th scope="col">Config Key</th> | ||
| 49 | <th scope="col">Meaning</th> | ||
| 50 | </tr> | ||
| 51 | </thead> | ||
| 52 | <tbody> | ||
| 53 | <tr> | ||
| 54 | <td scope="row"><code>hard-tabs</code></td> | ||
| 55 | <td> | ||
| 56 | Whether to insert a literal TAB character when pressing the TAB key or just the equivalent | ||
| 57 | amount of spaces (see <code>tab-stop</code>). | ||
| 58 | </td> | ||
| 59 | </tr> | ||
| 60 | <tr> | ||
| 61 | <td scope="row"><code>line-limit</code></td> | ||
| 62 | <td>Line length past which all characters get a red background.</td> | ||
| 63 | </tr> | ||
| 64 | <tr> | ||
| 65 | <td scope="row"><code>page-overlap</code></td> | ||
| 66 | <td>Amount of lines shared when scrolling up or down with PageDown (C-v) or PageUp (M-v).</td> | ||
| 67 | </tr> | ||
| 68 | <tr> | ||
| 69 | <td scope="row"><code>tab-stop</code></td> | ||
| 70 | <td>How many spaces a single tab equates to.</td> | ||
| 71 | </tr> | ||
| 72 | </tbody> | ||
| 73 | </table> | ||
| 74 | |||
| 75 | |||