diff --git a/README.md b/README.md new file mode 100644 index 0000000..37498cf --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +## clx-truetype + +Pure Common Lisp TrueType antialiased fonts rendering using +[CLX](https://github.com/sharplispers/clx) and the Xrender extension. + +Although a fork, this repository is to be [considered the **principal** +clx-truetype fork](https://github.com/stumpwm/stumpwm/discussions/1109) +and the de facto continuation of the development effort. +Initially, clx-truetype was written by +[Mikhail Filonenko](https://github.com/filonenko-mikhail). Over the years, +however, additions and fixes have mainly happened across different forks as +Mikhail's own repository has disappeared. This repository therefore +consolidates these changes, provides proper versioning and strives to +remain active. + +clx-truetype is especially important for users of +[StumpWM](https://github.com/stumpwm/stumpwm) because it allows the window +manager to display text using TTF fonts. To use StumpWM with clx-truetype +you have to install the +[ttf-fonts](https://github.com/stumpwm/stumpwm-contrib/tree/master/util/ttf-fonts) +contrib module. The usage of the module is beyond this documentation. + diff --git a/README.txt b/README.txt deleted file mode 100644 index 6b849ac..0000000 --- a/README.txt +++ /dev/null @@ -1,9 +0,0 @@ -Pure Common Lisp TrueType antialiased fonts rendering using CLX and Xrender -extension. - -Web manual: -http://filonenko-mikhail.github.com/clx-truetype/ - -email: filonenko.mikhail at gmail.com -jabber: asvil@jabber.ru -skype: filonenko.mikhail