From cb52480d4ef9ebf7d448370de01d63508c602fbf Mon Sep 17 00:00:00 2001 From: LaraFuhrmann <55209716+LaraFuhrmann@users.noreply.github.com> Date: Tue, 7 May 2024 12:23:03 +0200 Subject: [PATCH] update readme with clarifications for tutorials --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 0571757d..6ed5bcba 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,11 @@ Also see [snakemake's documentation](https://snakemake.readthedocs.io/en/stable/ Tutorials introducing usage of V-pipe are available in the [docs/](docs/README.md) subdirectory. + +### Tutorials + +First steps with V-pipe for different scenarios are available in the [docs/](docs/README.md) subdirectory. + ### Using quick install script To deploy V-pipe, use the [installation script](utils/README.md#quick-installer) with the following parameters: @@ -50,6 +55,8 @@ cd work ./vpipe --jobs 4 --printshellcmds --dry-run ``` +Test data is available with the tutorials provided in the [docs/](docs/README.md) subdirectory. + ### Using Docker Note: the [docker image](https://github.com/cbg-ethz/V-pipe/pkgs/container/v-pipe) is only setup with components to run the workflow for HIV and SARS-CoV-2 virus base configurations.