hashirama/metabrush
1
0
Fork 0
mirror of https://gitlab.com/sheaf/metabrush.git synced 2024-11-23 15:34:06 +00:00
Code Issues Actions Projects Releases Wiki Activity

update readme

Browse source
This commit is contained in:
sheaf 2024-10-12 17:17:58 +02:00
parent 4606d0b543
commit d8c83140e7
1 changed files with 15 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
readme.md
View file

@ -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.