#A wide-screen reading app

Use all available width to read (no editing).

broadsheet.love is a "freewheeling" app that you can read and modify the source code for as it runs. Designed above all to be easy to modify and give you early warning if your modifications break something.

#Getting started

Install LÖVE. It's just a 5MB download, open-source and extremely well-behaved. I'll assume below that you can invoke it using the love command, but that might vary depending on your OS.

To run from the terminal, pass this directory to LÖVE, optionally with a file path to edit.

$ path/to/love path/to/broadsheet.love path/to/file

Alternatively, turn it into a .love file you can double-click on:

$ zip -r /tmp/broadsheet.love *.lua

To load a file, drop it on the broadsheet.love window.

When restarting, broadsheet.love will load the file from the previous session by default.

#Hacking

To modify it live without restarting the app each time, download the driver app. Here's an example session with a different freewheeling app:

Some reference documentation on how to create your own apps.

To publish your changes:

• delete all files with a numeric prefix from the repo, and then
• move all files with a numeric prefix from the save directory to the repo.

#Keyboard shortcuts

• pgUp/pgDn to scroll
• ctrl+f to find patterns within a file
• ctrl+= to zoom in, ctrl+- to zoom out, ctrl+0 to reset zoom
• mouse drag or shift + movement to select text, ctrl+a to select all, ctrl+c to copy selection to clipboard

#Known issues

• Both freewheeling apps and the driver for them currently benefit from being launched in terminal windows rather than by being clicked on in a desktop OS. See the driver app for details.

• No support yet for Unicode graphemes spanning multiple codepoints.

• No support yet for right-to-left languages.

• Can't scroll while selecting text with mouse.

• No scrollbars yet. That stuff is hard.

#Mirrors and Forks

This repo is a fork of lines.love, an editor for plain text where you can also seamlessly insert line drawings. Its immediate upstream is the template repo for freewheeling apps. Updates to it can be downloaded from:

• https://git.sr.ht/~akkartik/broadsheet.love

Further forks are encouraged. If you show me your fork, I'll link to it here.

#Feedback

Most appreciated.