Skip to content

Commit 83163bb

Browse files
committed
mention NXF version cap. fix some broken URLs
1 parent 3a84510 commit 83163bb

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515

1616
[![Get help on Slack](http://img.shields.io/badge/slack-nf--core%20%23eager-4A154B?logo=slack)](https://nfcore.slack.com/channels/eager)
1717

18+
>[!IMPORTANT]
19+
> nf-core/eager versions 2.* are only compatible with Nextflow versions up to 22.10.6!
20+
1821
## Introduction
1922

2023
<!-- nf-core: Write a 1-2 sentence summary of what data the pipeline is for and what it does -->
@@ -28,7 +31,7 @@ The pipeline is built using [Nextflow](https://www.nextflow.io), a workflow tool
2831

2932
## Quick Start
3033

31-
1. Install [`nextflow`](https://nf-co.re/usage/installation) (`>=20.07.1`)
34+
1. Install [`nextflow`](https://nf-co.re/usage/installation) (`>=20.07.1` && `<=22.10.6`)
3235

3336
2. Install any of [`Docker`](https://docs.docker.com/engine/installation/), [`Singularity`](https://www.sylabs.io/guides/3.0/user-guide/), [`Podman`](https://podman.io/), [`Shifter`](https://nersc.gitlab.io/development/shifter/how-to-use/) or [`Charliecloud`](https://hpc.github.io/charliecloud/) for full pipeline reproducibility _(please only use [`Conda`](https://conda.io/miniconda.html) as a last resort; see [docs](https://nf-co.re/usage/configuration#basic-configuration-profiles))_
3437

@@ -52,7 +55,7 @@ The pipeline is built using [Nextflow](https://www.nextflow.io), a workflow tool
5255
nextflow clean -f -k
5356
```
5457

55-
See [usage docs](https://nf-co.re/eager/docs/usage.md) for all of the available options when running the pipeline.
58+
See [usage docs](https://nf-co.re/eager/usage) for all of the available options when running the pipeline.
5659

5760
**N.B.** You can see an overview of the run in the MultiQC report located at `./results/MultiQC/multiqc_report.html`
5861

@@ -133,9 +136,9 @@ The nf-core/eager pipeline comes with documentation about the pipeline: [usage](
133136
* [Pipeline installation](https://nf-co.re/usage/local_installation)
134137
* [Adding your own system config](https://nf-co.re/usage/adding_own_config)
135138
* [Reference genomes](https://nf-co.re/usage/reference_genomes)
136-
3. [Running the pipeline](https://nf-co.re/eager/docs/usage.md)
139+
3. [Running the pipeline](https://nf-co.re/eager/usage)
137140
* This includes tutorials, FAQs, and troubleshooting instructions
138-
4. [Output and how to interpret the results](https://nf-co.re/eager/docs/output.md)
141+
4. [Output and how to interpret the results](https://nf-co.re/eager/output)
139142

140143
## Credits
141144

0 commit comments

Comments
 (0)