From 32350eb896fa7c3579f8b1ea6f6d16cb738c5e5d Mon Sep 17 00:00:00 2001 From: Adrian Cochrane Date: Thu, 9 Feb 2023 16:20:43 +1300 Subject: [PATCH] Add initial README. --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..832156f --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# FontConfig Pure +[Source Code](https://git.argonaut-constellation.org/~alcinnz/fontconfig-pure) [Issues](https://todo.argonaut-constellation.org/~alcinnz/fontconfig-pure) [Hackage](https://hackage.haskell.org/package/fontconfig-pure) + +Pure-functional language bindings to [FontConfig](https://www.freedesktop.org/wiki/Software/fontconfig/). Mostly consists of conversions between common Haskell types & FontConfig's imperative C types. + +Queries a database of fonts, both in-memory & on the local filesystem, to find the one most closely matching your desired font-family, style, & size. + +## Requirements +* FontConfig 2.13 or greater +* LibStdC++ (for Text dependency) +* Cabal + +Cabal can install the rest. + +## Use +Please see the Haddock documentation for API usage. + +Contains a demo program in `Main.hs`, which can be run via `cabal run`, to query the system font database using standard FontConfig query syntax given in commandline arguments. + +There's a tentative expansion with its own testscript which bridges over to Harfbuzz-Pure, & includes a testscript which renders "sphinx of black quartz judge my vow" using the best matching fontfile for your query. This is being held up until a new version of Haskell CSS Syntax is released to Hackage supporting UTF-8 Text. -- 2.30.2