Update readme with basic intro

This commit is contained in:
Vivianne 2024-03-02 14:12:31 -05:00
parent 6670b98817
commit b4b7960b9f

View file

@ -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`.