set up documentation before publishing repo

README.md

@@ -1,10 +1,12 @@
-# Example "freewheeling" app that can be modified without being restarted
+# Toy interpreter for Brainf@@k
 
-Running this repo in isolation won't be very helpful. If you haven't yet,
+https://en.wikipedia.org/wiki/Brainfuck
-first check out [the driver app](https://codeberg.org/akkartik/driver.love).
+
-This repo is a template you can copy to create your own live apps that juggle
+![screenshot](assets/bf.gif)
-text editor widgets. The editors support copy/paste, search, infinite undo,
+
-etc. You can't modify editor functionality live (yet?).
+Example program for trying out [driver.love](https://git.sr.ht/~akkartik/driver.love),
+a programming environment for modifying programs live, without restarting
+them.
 
 [More information about the on-disk representation of freewheeling apps.](representation.md)
 
@@ -18,14 +20,15 @@ modifications break something.
 Run this app from the terminal, [passing its directory to LÖVE](https://love2d.org/wiki/Getting_Started#Running_Games)
 
 To modify it live without restarting the app each time, install [the driver
-app](https://codeberg.org/akkartik/driver.love). Here's an example session
+app](https://git.sr.ht/~akkartik/driver.love).
-using a fork of this repo:
 
-![making changes without restarting the app](assets/2.gif)
+![screenshot of driver app showing overview of this repo](assets/bf-codemap.gif)
 
 ## Keyboard shortcuts
 
-Up to you! But within the included editor widget if you use it:
+Press `f4` to evaluate a program.
+
+Within each editor panel:
 
 * `ctrl+f` to find patterns within a file
 * `ctrl+c` to copy, `ctrl+x` to cut, `ctrl+v` to paste
@@ -66,18 +69,14 @@ found anything amiss: http://akkartik.name/contact
 ## Mirrors and Forks
 
 This repo is a fork of lines.love at [http://akkartik.name/lines.html](http://akkartik.name/lines.html).
-Its immediate upstream is [text.love](https://codeberg.org/akkartik/text.love),
+Its immediate upstream is [template-live-editor](https://git.sr.ht/~akkartik/template-live-editor),
-a version without support for line drawings. Updates to it can be downloaded
+an empty app with support for live editing and editor widgets. Updates to it
-from the following mirrors:
+can be downloaded from the following mirrors:
 
-* https://codeberg.org/akkartik/template-live-editor
+* https://git.sr.ht/~akkartik/bf.love
-* https://git.sr.ht/~akkartik/template-live-editor
 
 Further forks are encouraged. If you show me your fork, I'll link to it here.
 
-* https://codeberg.org/akkartik/luaML.love - a "browser" for a Lua-based
-  markup language, loosely analogous to HTML except it's all Lua.
-
 ## Feedback
 
 [Most appreciated.](http://akkartik.name/contact)