From c98f986334d80e53da9e02b4cb390c0367e04f12 Mon Sep 17 00:00:00 2001 From: retropikzel Date: Fri, 11 Oct 2024 09:47:27 +0300 Subject: [PATCH] Update readme --- README.md | 39 +++++++++++++++++---------------------- 1 file changed, 17 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index fbc005b..286a6bf 100644 --- a/README.md +++ b/README.md @@ -5,15 +5,11 @@ The relevant part of Guix manual is [Additional Channels](https://guix.gnu.org/manual/en/html_node/Specifying-Additional-Channels.html). But here is short instructions anyway. -## Status +## Note about dependencies -In **alpha**. +Only libraries which are in snow-fort and not SRFIs are added to the Guix package as dependency. -Currently does not work other than used locally. Working on fixing the bugs tho! - -Clone locally and to use run: - - guix shell -L REPOSITORY_LOCATION/packages snow-package-name +See the part about installing srfi-libraries for more details. ## Add the Guix channell @@ -22,7 +18,7 @@ Copy this: (cons (channel (name 'snow-fort) - (url "https://gitea.scheme.org/Rinne/snow-fort-guix-channel.git")) + (url "https://gitea.scheme.org/Rinne/snow-fort-guix-channel.git")) %default-channels) Into: @@ -37,31 +33,30 @@ Run: guix pull -## Using packages - -### Note about dependencies - -Only libraries which are in snow-fort and not SRFIs are added to the Guix package as dependency. - -See the part about installing srfi-libraries for more details. - -### Guix shell +## Installing/using packages The packages have been prefixed with "snow-", so for example to use package (arvyy mustache) from [https://snow-fort.org/pkg](https://snow-fort.org/pkg) run: -guix shell snow-arvyy-mustache + guix install snow-arvyy-mustache + +or: + + guix shell snow-arvyy-mustache -And the library can be found from path ${GUIX_PROFILE}/share/snow. +And the library can be found from path ${GUIX_PROFILE}/lib/snow. -To use them add that path into your implementations loadpath. + +## Using the libraries + +To use the libraries add the installation path into your implementations loadpath. For example with Guile: - guile --r7rs -L ${GUIX_PROFILE}/share/snow + guile --r7rs -L ${GUIX_PROFILE}/lib/snow -### Installing SRFI libraries +## Installing SRFI libraries SRFI libraries are not yet packaged into this channel. See related [issue](https://gitea.scheme.org/Rinne/snow-fort-guix-channel/issues/2).