about summary refs log tree commit diff stats
path: root/README.md
diff options
context:
space:
mode:
authorKartik K. Agaram <vc@akkartik.com>2022-06-07 13:58:38 -0700
committerKartik K. Agaram <vc@akkartik.com>2022-06-07 13:58:38 -0700
commit7b78c359b6e5c22e981e3b7aef0c25214e10c669 (patch)
tree82d46f7e88034bad212fcfa57331a3b3f5f416be /README.md
parent1e33eeeffcb979301b2e88ee94f5c6c0febca086 (diff)
downloadview.love-7b78c359b6e5c22e981e3b7aef0c25214e10c669.tar.gz
clearer discription of how to run lines.love
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 22 insertions, 5 deletions
diff --git a/README.md b/README.md
index 7675f8a..3d77314 100644
--- a/README.md
+++ b/README.md
@@ -6,19 +6,36 @@ modifications break something.
 
 http://akkartik.name/lines.html
 
-## Selecting files
+## Invocation
+
+Like all LÖVE apps, lines.love can be invoked either from a terminal or
+by clicking on the application in a graphical desktop.
+
+When invoked from a terminal, you can pass the love binary the path to either
+the zipped lines.love or a directory containing lines.love unzipped.
+
+```sh
+$ path/to/love path/to/lines.love
+
+$ path/to/love .  # from this repo directory
+$ path/to/love path/to/lines/directory  # from anywhere
+```
 
 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.
+When invoked from a terminal, you can pass in a different file to edit, either
+to the zipped or unzipped versions:
 
 ```sh
-$ love . /path/to/file  # from this repo directory
-$ path/to/love path/to/lines.love path/to/file/to/edit  # from anywhere
+$ path/to/love path/to/lines.love path/to/file/to/edit
+
+$ path/to/love path/to/lines/directory /path/to/file/to/edit
 ```
 
+On a graphical desktop you can also drag and drop a file icon on to the
+lines.love window.
+
 ## Keyboard shortcuts
 
 While editing text: