From 4bab547c66456e41609b26ed87aa261c9712499a Mon Sep 17 00:00:00 2001 From: Vivianne Langdon Date: Sat, 2 Mar 2024 14:23:36 -0500 Subject: [PATCH] Oops wrong project lol here is a proper readme --- README.org | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.org b/README.org index 0f2f538..cbe9c13 100644 --- a/README.org +++ b/README.org @@ -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.