README: add

current
Síle Ekaterin Liszka 2023-11-27 13:48:25 -08:00
parent 79748bc282
commit e549ce7332
1 changed files with 24 additions and 0 deletions

24
README.md Normal file
View File

@ -0,0 +1,24 @@
# Smeargle
A tool for rendering text using bitmap images in PNG format, C version.
# Build Requirements
To build this project, you will need:
- libtoml (tomlc99); an embedded copy is available as a fallback if a system version isn't.
- libgd
- meson
- ninja
Building `smeargle`:
```sh
meson setup . output
meson compile
```
# License
This program is released under the MIT license; a copy of this license is provided in `LICENSE.md`.