From 253cd011d4d00351da0ae30f39b44d340bbcc36e Mon Sep 17 00:00:00 2001 From: Arun Isaac Date: Mon, 29 Nov 2021 21:03:08 +0530 Subject: README: Add instructions for installation using software bundles. * README.org (Installation)[Using binary software bundles]: New subsection. --- README.org | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.org b/README.org index a9504a8..695a265 100644 --- a/README.org +++ b/README.org @@ -15,6 +15,37 @@ can interactively execute workflows while developing them. #+END: * Installation +** Using binary software bundles + +If you don't have [[https://guix.gnu.org/][GNU Guix]] set up, the easiest way to quickly try ccwl +is to using the provided software bundles---either using the Guix +tarball pack or the Docker image. + +*** Using the Guix tarball pack + +Download the Guix tarball pack from [[https://github.com/arunisaac/ccwl/releases][the GitHub releases page]] and +extract it. Then, run ccwl with command-line arguments of your choice. +#+BEGIN_SRC shell + $ tar -xf ccwl-pack.tar.gz + $ ./opt/gnu/bin/ccwl [ARGS...] +#+END_SRC + +*** Using the Docker image + +Download the Docker image from [[https://github.com/arunisaac/ccwl/releases][the GitHub releases page]] and load +it. Then, run ccwl with command-line arguments of your choice. +#+BEGIN_SRC shell + $ docker load -i ccwl-docker.tar.gz + $ docker run ccwl [ARGS...] +#+END_SRC + +When passing files into the Docker container, remember to share the +filesystem. The following command is one way to share the current +directory with the container. +#+BEGIN_SRC shell + $ docker run -v "$PWD:$PWD" -w "$PWD" ccwl compile foo.scm +#+END_SRC + ** Using Guix The easiest and best way (considering reproducibility) is to install -- cgit v1.2.3