summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDylan Araps <dylan.araps@gmail.com>2018-10-21 16:09:59 +1100
committerDylan Araps <dylan.araps@gmail.com>2018-10-21 16:09:59 +1100
commit9269c20f92002fe406eb85c818cdf3a536a81585 (patch)
tree8545b5ba663682e27e10d26045b7cc3089f1c73d
parent93a59ba98ae0b6d4b8c865f287affe19707e6114 (diff)
docs: update
-rw-r--r--CONTRIBUTING.md25
1 files changed, 21 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index db5f1c2..f526907 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,7 +1,20 @@
# CONTRIBUTING
+<!-- vim-markdown-toc GFM -->
-# Variables
+* [Index](#index)
+ * [Variables](#variables)
+ * [Functions](#functions)
+ * [Escape Sequences](#escape-sequences)
+ * [Traps](#traps)
+* [Components](#components)
+ * [Scroll](#scroll)
+
+<!-- vim-markdown-toc -->
+
+# Index
+
+## Variables
| var | meaning |
| ------- | ------- |
@@ -17,7 +30,7 @@
| `l2[@]` | history of parent dir nest level. |
-# Functions
+## Functions
| func | meaning |
| ----------- | ------- |
@@ -32,7 +45,7 @@
| `main()` | set traps and start loop. |
-# Escape Sequences
+## Escape Sequences
| sequence | meaning |
| ----------- | ------- |
@@ -50,10 +63,14 @@
| `\e[K` | clear from cursor position to end of line. |
| `\e[999B` | move cursor `999` lines down (go-to-bottom). |
-# TRAPS
+## Traps
| trap | meaning |
| ----------- | ------- |
| `SIGWINCH` | on terminal resize. |
| `EXIT` | on terminal exit. |
+
+# Components
+
+## Scroll