From 16350399ac4eb15274e065f113ad808c96dc600f Mon Sep 17 00:00:00 2001
From: Blaž Hrastnik
Date: Mon, 5 Apr 2021 15:18:43 +0900
Subject: Add book/ (mdbook based user guide)

---
 book/src/SUMMARY.md       |  7 +++++++
 book/src/configuration.md |  1 +
 book/src/hooks.md         |  1 +
 book/src/install.md       | 34 ++++++++++++++++++++++++++++++++++
 book/src/keymap.md        | 18 ++++++++++++++++++
 book/src/usage.md         |  1 +
 6 files changed, 62 insertions(+)
 create mode 100644 book/src/SUMMARY.md
 create mode 100644 book/src/configuration.md
 create mode 100644 book/src/hooks.md
 create mode 100644 book/src/install.md
 create mode 100644 book/src/keymap.md
 create mode 100644 book/src/usage.md

(limited to 'book/src')

diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md
new file mode 100644
index 00000000..474c2e70
--- /dev/null
+++ b/book/src/SUMMARY.md
@@ -0,0 +1,7 @@
+# Summary
+
+- [Installation](./install.md)
+- [Usage](./usage.md)
+- [Configuration](./configuration.md)
+  - [Keymap](./keymap.md)
+  - [Hooks](./hooks.md)
diff --git a/book/src/configuration.md b/book/src/configuration.md
new file mode 100644
index 00000000..a025a48b
--- /dev/null
+++ b/book/src/configuration.md
@@ -0,0 +1 @@
+# Configuration
diff --git a/book/src/hooks.md b/book/src/hooks.md
new file mode 100644
index 00000000..744f34e8
--- /dev/null
+++ b/book/src/hooks.md
@@ -0,0 +1 @@
+# Hooks
diff --git a/book/src/install.md b/book/src/install.md
new file mode 100644
index 00000000..48813bee
--- /dev/null
+++ b/book/src/install.md
@@ -0,0 +1,34 @@
+# Installation
+
+TODO: Prebuilt binaries on GitHub Releases page
+
+## OSX
+
+TODO: brew tap
+
+```
+$ brew tap helix-editor/helix
+$ brew install helix
+```
+
+## Linux
+
+### NixOS
+
+A [flake](https://nixos.wiki/wiki/Flakes) containing the package is available in
+the project root. The flake can also be used to spin up a reproducible development
+shell for working on Helix.
+
+### Arch Linux
+
+TODO: AUR
+
+## Build from source
+
+```
+$ git clone --depth 1 --recurse-submodules -j8 https://github.com/helix-editor/helix
+$ cd helix
+$ cargo install --path helix-term
+```
+
+This will install the `hx` binary to `$HOME/.cargo/bin`.
diff --git a/book/src/keymap.md b/book/src/keymap.md
new file mode 100644
index 00000000..995b4688
--- /dev/null
+++ b/book/src/keymap.md
@@ -0,0 +1,18 @@
+# Keymap
+
+
+## Movement
+
+| Key | Description |
+|-----|-----------|
+| h   | move left |
+| j   | move down |
+| k   | move up |
+| l   | move right |
+| w   | move next word start |
+| b   | move previous word start |
+| e   | move next word end |
+
+| Key | Description |
+|-----|-----------|
+| a   | Append to end of selection |
diff --git a/book/src/usage.md b/book/src/usage.md
new file mode 100644
index 00000000..8f04b05a
--- /dev/null
+++ b/book/src/usage.md
@@ -0,0 +1 @@
+# Usage
-- 
cgit v1.2.3-70-g09d2