about summary refs log tree commit diff
path: root/README.org
diff options
context:
space:
mode:
authorArun Isaac2022-06-10 14:55:41 +0530
committerArun Isaac2022-06-14 13:25:10 +0530
commit1437bd3cc92a309a74bcc830b15f85024f00e9ee (patch)
tree048baeef5d8184ebc36b3e69c46ddf2682756c00 /README.org
parentc10741079757339b5309d1a9e26dd9c791fe6320 (diff)
downloadguix-bioinformatics-1437bd3cc92a309a74bcc830b15f85024f00e9ee.tar.gz
Depend on specific commit of Guix upstream.
* .guix-channel: Depend on specific commit of Guix upstream.
* README.org: Update recommended channels.scm and explain dependence
on specific commit.
Diffstat (limited to 'README.org')
-rw-r--r--README.org17
1 files changed, 9 insertions, 8 deletions
diff --git a/README.org b/README.org
index 02968a6..9636542 100644
--- a/README.org
+++ b/README.org
@@ -16,17 +16,18 @@ To easily use the packages from this repo, simply add it to your
 [[https://guix.gnu.org/manual/en/html_node/Channels.html][here]]:
 
 #+BEGIN_SRC scheme
-    (cons*
-      (channel
-        (name 'gn-bioinformatics)
-        (url "https://git.genenetwork.org/guix-bioinformatics/guix-bioinformatics.git")
-        (branch "master"))
-      %default-channels)
+  (list (channel
+         (name 'gn-bioinformatics)
+         (url "https://git.genenetwork.org/guix-bioinformatics/guix-bioinformatics.git")
+         (branch "master")))
 #+END_SRC
 
-and run `guix pull` like normal to update your software. This is the
+and run /guix pull/ like normal to update your software. This is the
 recommended way to use the software from this repository and the code
-snippets in this README assume you have done so.
+snippets in this README assume you have done so. In order to maintain
+stability, the guix-bioinformatics channel depends on a specific
+commit of upstream Guix. So, it is recommended to isolate use of the
+guix-bioinformatics channel in a separate /guix pull/ profile.
 
 If you want to make changes to the packages in this repo then simply set
 the GUIX_PACKAGE_PATH to point to the root of this directory