Skip to content

Commit 8df1660

Browse files
committed
Add link to snakemake workflow requirements
1 parent 4e6bb22 commit 8df1660

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@ We recommend using [`pixi`](https://pixi.sh/) as your package manager. Once inst
4747

4848
## Features
4949

50-
- Standardised layout compliant with the [snakemake workflow catalogue's](https://snakemake.github.io/snakemake-workflow-catalog/#) listing requirements.
50+
- Standardised layout compliant with the [snakemake workflow catalogue's](https://snakemake.github.io/snakemake-workflow-catalog/#) listing requirements, enabling them to be automatically included in their listings once published. Read more about those requirements [here](https://snakemake.github.io/snakemake-workflow-catalog/docs/catalog.html#standardized-usage-workflows).
51+
- Standardised input/output structure across modules:
5152
- `resources/`: files needed for the module's processes.
5253
- `user/`: files that should be provided by users. Document them well!
5354
- `automatic/`: files that the module downloads or prepares in intermediate steps.
@@ -56,7 +57,6 @@ We recommend using [`pixi`](https://pixi.sh/) as your package manager. Once inst
5657
- Continuous Integration (CI) settings, ready for [pre-commit.ci](https://pre-commit.ci/).
5758
- GitHub actions to automate chores during pull requests and releases.
5859
- Premade `pytest` setup.
59-
- Documentation setup, ready for [Read the Docs](https://about.readthedocs.com/) or [Github Pages](https://pages.github.com/).
6060

6161
> [!IMPORTANT]
6262
>

0 commit comments

Comments
 (0)