From b4b7960b9fcb3ff10186ca3200612e92467b0bce Mon Sep 17 00:00:00 2001 From: Vivianne Langdon Date: Sat, 2 Mar 2024 14:12:31 -0500 Subject: [PATCH] Update readme with basic intro --- README.org | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.org b/README.org index f9901cd..0f2f538 100644 --- a/README.org +++ b/README.org @@ -1,4 +1,12 @@ # -*- mode: org; coding: utf-8; -*- -#+TITLE: README for Reflow +#+TITLE: README for Guile Reflow +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. + +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 `reflow`.