Merge pull request #63 from uclahs-cds/nwiltsie-add-requirements

Add requirements to README
uclahs-cds · Apr 5, 2024 · cd8c2a1 · cd8c2a1
2 parents 99d0e8c + 7c39c90
commit cd8c2a1
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,6 +21,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - Output pipeline parameters to log directory using `store_object_as_json`
 - Add Action to deploy documentation to GitHub Pages
 - Add Nextflow configuration test action and two regression tests
+- Add requirements to README
 
 ### [Changed]
 - Use modularized `set_env` function

diff --git a/README.md b/README.md
@@ -18,6 +18,8 @@ This pipeline takes BAMs and corresponding indices from [pipeline-align-DNA](htt
 
 ## How To Run
 
+**Requirements**: Currently supported Nextflow versions: `23.04.2`
+
 **The pipeline is currently configured to run on a SINGLE NODE mode with normal only, tumor only, normal-tumor paired, or multiple normal and tumor samples.**
 
 1. Update the params section of the .config file ([Example config](config/template.config)).