2024-02-09 13:56:13 +00:00
|
|
|
# -*- mode: org; coding: utf-8; -*-
|
|
|
|
|
|
|
|
#+TITLE: README for Guile-Termenv
|
|
|
|
|
2024-02-11 19:07:12 +00:00
|
|
|
~guile-termenv~ is a port of [[https://github.com/muesli/termenv][termenv]] to Guile. It provides a convenient
|
|
|
|
interface to ANSI control sequences so you can color and style output without
|
|
|
|
need to bother with arcane symbols, all to the height of your terminal's
|
|
|
|
capabilities.
|
|
|
|
|
|
|
|
While ~guile-termenv~ is not a 1:1 port of ~termenv~, it does provide much of
|
|
|
|
the same functionality, and it aims to fill the same niche in the Guile
|
|
|
|
ecosystem that ~termenv~ does in the Go ecosystem.
|
|
|
|
|
|
|
|
* Building
|
|
|
|
|
|
|
|
~guile-termenv~ is developed using [[https://guix.gnu.org][Guix]] and the simplest way to build it is with
|
|
|
|
Guix. Running ~guix build -f guix.scm~ will build and test the project, placing
|
|
|
|
it in the store. Instead using ~guix shell -f guix.scm~ will create an
|
|
|
|
environment with the project, and ~guix profile -if guix.scm~ will install it.
|
|
|
|
|
|
|
|
If you wish to use a more manual build methodology, you can replicate the build
|
|
|
|
steps like so:
|
|
|
|
|
|
|
|
#+BEGIN_SRC shell
|
|
|
|
guix shell -Df guix.scm
|
|
|
|
autoreconf -vif
|
|
|
|
./configure
|
|
|
|
make -j
|
|
|
|
#+END_SRC
|
|
|
|
|
|
|
|
Note that it is not advised to install the project this way.
|
|
|
|
|
|
|
|
If you don't have or don't want to use Guix, ~guile-termenv~ requires the
|
|
|
|
following dependencies to build:
|
|
|
|
|
|
|
|
- autoconf
|
|
|
|
- automake
|
|
|
|
- pkg-config
|
|
|
|
- texinfo
|
|
|
|
|
|
|
|
With those dependencies installed, the same build commands as above will work,
|
|
|
|
although the ~guix~ command becomes redundant.
|