From f0e967d2a1d9d7ceee5812accb5501b73c17ec39 Mon Sep 17 00:00:00 2001
From: "Kartik K. Agaram" <vc@akkartik.com>
Date: Mon, 6 Jun 2022 18:33:44 -0700
Subject: flesh out Readme

---
 README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 06782ea..fdf7316 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,37 @@
 # Plain text with lines
 
+An editor for plain text where you can also seamlessly insert line drawings.
+Designed above all to be easy to modify and give you early warning if your
+modifications break something.
+
 http://akkartik.name/lines.html
 
+## Selecting files
+
+By default, lines.love reads/writes the file `lines.txt` in your default
+user/home directory (`https://love2d.org/wiki/love.filesystem.getUserDirectory`).
+
+To open a different file, either pass it in as a commandline argument or drag
+and drop the file on to the lines.love window.
+
+```sh
+$ love . /path/to/file  # from this repo directory
+$ path/to/love path/to/lines.love path/to/file/to/edit  # from anywhere
+```
+
+## Keyboard shortcuts
+
+While editing text:
+* `ctrl+f` to find patterns within a file
+* `ctrl+c` to copy, `ctrl+x` to cut, `ctrl+v` to paste
+* `ctrl+z` to undo, `ctrl+y` to redo
+* `ctrl+=` to zoom in, `ctrl+-` to zoom out, `ctrl+0` to reset zoom
+
+For shortcuts while editing drawings, consult the online help. Either:
+* hover on a drawing and hit `ctrl+h`, or
+* click on a drawing to start a stroke and then press and hold `h` to see your
+  options at any point during a stroke.
+
 ## Known issues
 
 * There's a bug in freehand drawings (C-p mode) that causes them to be
@@ -53,3 +83,22 @@ http://akkartik.name/lines.html
 * Can't scroll while selecting text with mouse.
 
 * No scrollbars yet. That stuff is hard.
+
+## Mirrors and Forks
+
+Updates to lines.love can be downloaded from the following mirrors in addition
+to the website above:
+* https://github.com/akkartik/lines.love
+* https://repo.or.cz/lines.love.git
+* https://codeberg.org/akkartik/lines.love
+* https://tildegit.org/akkartik/lines.love
+* https://git.tilde.institute/akkartik/lines.love
+* https://git.sr.ht/~akkartik/lines.love
+* https://pagure.io/lines.love
+
+Forks of Teliva are encouraged. If you show me your fork, I'll link to it
+here.
+
+## Feedback
+
+[Most appreciated.](http://akkartik.name/contact)
-- 
cgit 1.4.1-2-gfad0