docs: readme+license

1 files changed, 59 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e487077
--- /dev/null
+++ b/README.md
@@ -0,0 +1,59 @@
+# todo
+
+a little modal todo list that lives in my terminal.
+
+## keys
+
+```text
+= movement
+  h j k l        move (h/l caret in the item, j/k between items)
+  w / b          next / previous word
+  { / }          previous / next section
+  gg / G         top / bottom
+  3j, 2dd, ...   a count repeats the next motion or operator
+
+= editing
+  o              add a new item below
+  i              insert at the cursor
+  A              append to the item's text
+  R              replace the item's text
+  x              toggle done
+  space          cycle todo -> doing -> done
+  dd             cut the item
+  D              clear every done item
+  yy p P         yank, paste below, paste above
+  J / K          move the item down / up (on a heading, moves the whole section)
+
+= other
+  / n N          search, next match, previous match
+  u  ctrl-r      undo, redo
+  :w :q :wq :x   write, quit, write and quit
+  :reset         set every item back to todo
+  :clear         remove every item
+```
+
+## items
+
+```text
+= project          a section        -> I. project
+== phase one       a subsection     -> i. phase one
+- write the docs   a subtask
+buy milk           a plain task
+```
+
+## build
+
+```sh
+$ sudo make install            # -> /usr/local/bin + man page
+$ make install PREFIX=~/.local # or somewhere without sudo
+```
+
+it's one file, so if you don't want the makefile:
+
+```sh
+$ cc -O2 todo.c -o todo
+```
+
+## license
+
+`todo` is licensed under the mit license. see [license](LICENSE) for more.