diff --git a/README.md b/README.md index cc2a0c9..5f8a7ae 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,29 @@ -= guix-glicid ![CI Badge]https://guix.glicid.fr/jobset/glicid/badge.svg?type=1 +guix-glicid +=== +Description +--- +We define in this repository packages that we use at GLiCID HPC that are etheir not in guix main channels or with custom definitions. -two channels here : devel and main. -Please use main for something stable. +Two channels here : +- main ![CI Badge](https://guix.glicid.fr/jobset/glicid/badge.svg?type=1) : stable release of our channel +- devel ![CI Badge](https://guix.glicid.fr/jobset/glicid-devel/badge.svg?type=1) : development release of our channel, things may get broken + +How to use +--- +To use the guix-glicid channel, add these lines to ~/.config/guix/channels.scm or /etc/guix/channels.scm : + +For stable release : +``` +(channel + (name 'glicid) + (url "https://gitlab.univ-nantes.fr/glicid-public/guix-glicid.git") + (branch "main")) +``` + +For devel release : +``` +(channel + (name 'glicid) + (url "https://gitlab.univ-nantes.fr/glicid-public/guix-glicid.git") + (branch "devel")) +```