initial Readme for sokoban.love

README.md

@@ -1,12 +1,17 @@
-# Lua Carousel
+# Sokoban
 
 ![screenshot](assets/1.png)
 
-A lightweight environment for writing small, throwaway
-[Lua](https://www.lua.org) and [LÖVE](https://love2d.org) programs. Tested on
-Windows, Mac, Linux, iOS and Android. The environment itself can be modified
-as it runs. In early release; please report issues, particularly with
-usability or accessibility.
+A cross-platform, hackable app for playing 300 publicly available Sokoban
+puzzles. Runs on Windows, Mac, Linux, Android and iOS. You can edit the game
+and UI right on your device.
+
+To modify the editing environment itself or repurpose it for other apps, open
+it on a desktop environment. The environment itself can be modified as it
+runs.
+
+In early release; please report issues, particularly with usability or
+accessibility.
 
 This repo is an example of a [Freewheeling App](http://akkartik.name/freewheeling),
 designed above all to be easy to run, easy to modify and easy to share.
@@ -20,14 +25,16 @@ extremely well-behaved.
 
 ## Hacking
 
-To modify it live without restarting the app each time, download [the driver
-app](https://git.sr.ht/~akkartik/driver.love). Here's an example session
-using a fork of this repo:
+You can edit the game and UI right on your device.
+
+You can also modify the editing environment itself, or repurpose it for a
+different app entirely, live as it runs. This requires running it on a
+computer. Download [the driver app](https://git.sr.ht/~akkartik/driver.love).
+Here's an example session showing the driver (left window) editing a different
+app (right window containing yellow text):
 
 ![making changes without restarting the app](assets/2.gif)
 
-(Only on non-mobile platforms for now.)
-
 [Some reference documentation on how to create your own apps.](reference.md)
 
 If the app being modified by the driver lives in a .love file, your changes
@@ -74,13 +81,15 @@ Many thanks to Mike Stein for code, feedback and suggestions.
 
 This repo is a fork of [lines.love](http://akkartik.name/lines.html), an
 editor for plain text where you can also seamlessly insert line drawings.
-Its immediate upstream is [the template repo for freewheeling apps](https://git.sr.ht/~akkartik/template-live-editor).
-Updates to it can be downloaded from the following mirrors:
+Its immediate upstream is [Lua Carousel, a lightweight cross-platform
+environment for creating little throwaway scripts on a computer or
+phone](https://git.sr.ht/~akkartik/carousel.love). Updates to it can be
+downloaded from the following mirrors:
 
-* https://git.sr.ht/~akkartik/carousel.love
-* https://tildegit.org/akkartik/carousel.love
-* https://git.merveilles.town/akkartik/carousel.love
-* https://nest.pijul.com/akkartik/carousel.love (using the Pijul version control system)
+* https://git.sr.ht/~akkartik/sokoban.love
+* https://tildegit.org/akkartik/sokoban.love
+* https://git.merveilles.town/akkartik/sokoban.love
+* https://nest.pijul.com/akkartik/sokoban.love (using the Pijul version control system)
 
 Further forks are encouraged. If you show me your fork, I'll link to it here.