From d8c83140e77ab8f00d7e9bc729998ed80f418836 Mon Sep 17 00:00:00 2001 From: sheaf Date: Sat, 12 Oct 2024 17:17:58 +0200 Subject: [PATCH] update readme --- readme.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index f363a4a..ca979d2 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,4 @@ -# MetaBrush: if METAFONT had an UI +# MetaBrush: if METAFONT had a GUI **MetaBrush** is an application for creating brush-based fonts. It works on the level of brush strokes, unlike most font-editors that work with @@ -6,9 +6,22 @@ outline-based fonts. ![MetaBrush screenshot](MetaBrush_screenshot.png) -## Resolution +## Installation instructions + +`cabal run exe:MetaBrush` will build and launch the application. + +You will need certain C libraries to be installed on your system and recognised +by `pkg-config`. See the [Install guide](installation_notes.md) for more information, or use the provided `shell.nix` Nix file (NB: not necessarily up-to-date). + +## Tips and tricks + +### Change UI size To increase or decrease the size of the UI, set the `GDK_SCALE` environment variable. The current default is `setenv GDK_SCALE=2`. +### Theming +You can customise the theme by editing `theme.css`. +There isn't (yet) a way to switch between themes in the UI; you will need to +relaunch the application for changes to take effect.