Skip to content

Commit

Permalink
Merge pull request #2 from MIvanchev/update-documentation
Browse files Browse the repository at this point in the history
Update README.md to clarify clx-truetype's situation.
  • Loading branch information
goose121 authored Mar 30, 2024
2 parents 2378039 + 8524f08 commit 02d068f
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 9 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

9 changes: 0 additions & 9 deletions README.txt

This file was deleted.

0 comments on commit 02d068f

Please sign in to comment.