From 496c9886cd07da7c55bf0c6f5dd51f54aac8e7fd Mon Sep 17 00:00:00 2001
From: Uko Kokņevičs
Date: Sun, 25 Feb 2024 19:06:03 +0200
Subject: Update KeyMap a lil bit, add a readme, a license, and a tmux config

---
 README.md | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 75 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a656032
--- /dev/null
+++ b/README.md
@@ -0,0 +1,75 @@
+ ES
+====
+
+ES is EMACS but without MACros.  This is a shitty little editor, should build with who-knows-which
+zig master version.
+
+This doesn't implement windowing as I don't think I can beat tmux for that.  It is expected that
+`C-c` will be used for the tmux prefix key so it is not being assigned to anything in ES.
+
+I have attached a tmux config in `dot-tmux.conf`, symlink `~/.config/tmux/tmux.conf` to it or base
+your own config on it, whatever floats your boat.
+
+Currently you have to guess the keybindings from `src/KeyMap.zig` + tmux, maybe at some point I will
+create a built in help screen.
+
+ Building
+----------
+
+Building this is very simple
+
+```sh
+$ zig build -Doptimize=ReleaseSafe
+```
+
+To run it without installing:
+
+```sh
+$ zig build -Doptimize=ReleaseSafe run
+```
+
+To install it (feel free to replace `~/.local` with any other prefix you want to use).
+
+```sh
+$ zig build -Doptimize=ReleaseSafe -p ~/.local
+```
+
+ Configuration
+---------------
+
+There is a very bare-bones configuration available.  An example with default values is installed to
+`$PREFIX/share/arkta/es/es.ini`, copy it to `~/.config/arkta/es/es.ini` (actually any
+`$XDG_CONFIG_HOME`, `$XDG_CONFIG_DIRS`, &c are supported).
+
+<table>
+  <caption>Configuration cheatsheet</caption>
+  <thead>
+    <tr>
+      <th scope="col">Config Key</th>
+      <th scope="col">Meaning</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td scope="row"><code>hard-tabs</code></td>
+      <td>
+        Whether to insert a literal TAB character when pressing the TAB key or just the equivalent
+        amount of spaces (see <code>tab-stop</code>).
+      </td>
+    </tr>
+    <tr>
+      <td scope="row"><code>line-limit</code></td>
+      <td>Line length past which all characters get a red background.</td>
+    </tr>
+    <tr>
+      <td scope="row"><code>page-overlap</code></td>
+      <td>Amount of lines shared when scrolling up or down with PageDown (C-v) or PageUp (M-v).</td>
+    </tr>
+    <tr>
+      <td scope="row"><code>tab-stop</code></td>
+      <td>How many spaces a single tab equates to.</td>
+    </tr>
+  </tbody>
+</table>
+
+
-- 
cgit v1.2.3