summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArun Isaac2021-11-19 17:46:12 +0530
committerArun Isaac2021-11-19 17:47:20 +0530
commitf051ec7626677204213dfe43e2d795a65f275945 (patch)
tree0a4df1e9c3feb3cefe2c14c706f2ae78ad8f0981
parente7a25941f716c2f12f9bd156398765faf906c830 (diff)
downloadccwl-f051ec7626677204213dfe43e2d795a65f275945.tar.gz
ccwl-f051ec7626677204213dfe43e2d795a65f275945.tar.lz
ccwl-f051ec7626677204213dfe43e2d795a65f275945.zip
README: Add installation instructions.
* README.org (Installation): New section.
-rw-r--r--README.org24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.org b/README.org
index 5afde36..a9504a8 100644
--- a/README.org
+++ b/README.org
@@ -14,6 +14,30 @@ can interactively execute workflows while developing them.
#+BEGIN: download
#+END:
+* Installation
+** Using Guix
+
+The easiest and best way (considering reproducibility) is to install
+ccwl through [[https://guix.gnu.org/][GNU Guix]]. The Guix package definition for ccwl is in the
+file /guix.scm/. You can use it to install ccwl by running
+#+BEGIN_SRC shell
+ $ guix package -if guix.scm
+#+END_SRC
+
+** Manually
+
+You can also install ccwl more traditionally using the provided GNU
+build system scripts. You will have to ensure that the necessary
+dependencies (guile and guile-libyaml) are installed, and then run
+
+#+BEGIN_SRC shell
+ $ ./bootstrap.sh
+ $ ./configure; make; make install
+#+END_SRC
+
+If you are using a release tarball, you may skip the /bootstrap.sh/
+step.
+
* Documentation
[[https://ccwl.systemreboot.net/manual/dev/en/][Documentation for ccwl]] is available online. If ccwl is installed on