improve driver Readme

This commit is contained in:
Kartik K. Agaram 2023-12-13 20:07:55 -08:00
parent fc3f4ad18e
commit 63a3011670
3 changed files with 18 additions and 10 deletions

View File

@ -22,7 +22,7 @@ in an internal directory, but might end up in your home directory. Using these
files, driver.love can make changes to these apps without needing to restart
them.
![demo](assets/20221228-luaML-driver.gif)
![demo](assets/luaML-driver.gif)
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.
@ -66,19 +66,27 @@ The driver will highlight them in green or red when they fail.
## Hacking
To edit formatting you'll need to modify the code for the app. To do
this 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:
While this app is used to help modify other apps, it is also itself a
freewheeling app you can modify with another copy of itself with just a few
changes. On a unix-like platform, run the following commands to turn this repo
into a "meta-driver":
![making changes without restarting the app](assets/2.gif)
```
sed -i -e 's/app_driver/driver_driver2/g' -e 's/driver_app/driver2_driver/' driver.lua
sed -i -e 's/driver2_driver/driver3_driver2/g' -e 's/driver_driver2/driver2_driver3/' live.lua
```
Now you can modify the code for the driver without restarting it each time.
Run some app, then run this driver, then run the meta-driver. Here's an
example session:
![making changes without restarting the app](assets/codemap-canvas.gif)
[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
will go into the [save directory](https://love2d.org/wiki/love.filesystem.getSaveDirectory).
If it lives in a directory (like this repo), your changes will go straight
into the same directory.
If you run off of this repo, changes to the driver will get saved right here.
If you first create a .love file, your changes will go into the
[save directory](https://love2d.org/wiki/love.filesystem.getSaveDirectory).
## Keyboard shortcuts

BIN
assets/codemap-canvas.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.0 MiB

View File

Before

Width:  |  Height:  |  Size: 4.4 MiB

After

Width:  |  Height:  |  Size: 4.4 MiB