Oops wrong project lol here is a proper readme

This commit is contained in:
Vivianne 2024-03-02 14:23:36 -05:00
parent b4b7960b9f
commit 4bab547c66

View file

@ -1,12 +1,14 @@
# -*- mode: org; coding: utf-8; -*-
#+TITLE: README for Guile Reflow
#+TITLE: README for Guile Runewidth
guile-reflow is a simple Guile library for wrapping text in terminals. It integrates with guile's port system
and provides an API that allows for easy creation of ports with a restricted line width.
guile-runewidth is a simple Guile library that provides several new Guile character sets for categorizing
East Asian characters and emoji. This can be useful when determining the width of characters.
The library attempts to be compatible with non-ascii characters and emoji, using the companion library
`guile-runewidth` to determine the best guess at rune widths (a notoriously difficult task to accomplish
accurately!).
This library is heavily inspired by the golang library `runewidth`.
This library is heavily inspired by the golang library `reflow`.
* Scripts
There are two scripts which can be used to regenerate the character set files. These are optional to run, since
the script's output is stored in the repository at runewidth/eastasian.scm and runewidth/emoji.scm.
However, should the source change as the unicode spec changes, these can be refreshed.