about summary refs log tree commit diff
diff options
context:
space:
mode:
authorArun Isaac2025-11-30 02:09:12 +0000
committerArun Isaac2025-11-30 02:09:12 +0000
commitf59cbf8498bd070b03910211f9a8a423446d227e (patch)
treec6a68a4a4ca14388585a2ee067de9a8935a16b99
parenta1b9ac146eb7375fcec7d5945707ad075b3df5f3 (diff)
downloadravanan-f59cbf8498bd070b03910211f9a8a423446d227e.tar.gz
ravanan-f59cbf8498bd070b03910211f9a8a423446d227e.tar.lz
ravanan-f59cbf8498bd070b03910211f9a8a423446d227e.zip
README: Describe Hello World example in doc directory.
-rw-r--r--README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/README.md b/README.md
index df90800..1eb635b 100644
--- a/README.md
+++ b/README.md
@@ -58,7 +58,12 @@ You can run a workflow `hello-world.cwl` with inputs in `hello-world-inputs.yaml
 ```
 ravanan hello-world.cwl hello-world-inputs.yaml --store=store --guix-manifest=manifest.scm
 ```
-`--store` specifies a directory to use as ravanan's store. `--guix-manifest` specifies a Guix manifest file that lists the dependencies required for the workflow. An example `hello-world.cwl` and `hello-world-inputs.json` are provided in the `doc` directory of this repository.
+`--store` specifies a directory to use as ravanan's store. `--guix-manifest` specifies a Guix manifest file that lists the dependencies required for the workflow.
+
+An example `hello-world.cwl` and `hello-world-inputs.json` are provided in the `doc` directory of this repository. You can run it like so:
+```
+ravanan --store=store --guix-manifest=doc/hello-world-manifest.scm doc/hello-world.cwl doc/hello-world-inputs.yaml
+```
 
 ## On HPC using slurm