From e549ce7332458655563c5702e84ea8ecf6545d05 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=ADle=20Ekaterin=20Liszka?= Date: Mon, 27 Nov 2023 13:48:25 -0800 Subject: [PATCH] README: add --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..254751a --- /dev/null +++ b/README.md @@ -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`. +