diff --git a/.github/workflows/README.md b/.github/workflows/README.md index 2dd269fd..3ce56d18 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -1,3 +1,11 @@ This directory stores workflow scripts that are picked up by GitHub Actions to automatically perform test installations of V-pipe on Mac OS and Linux systems and run end-to-end tests by executing tutorials with real example data. This ensures successful installation and reproducible execution on different systems. For each update of V-pipe these workflow scripts are automatically executed and report about installation problems or troubles on the test data + +Some of these workflows rely on additional data present in the [`tests/` directory](../../tests). + +### Tutorials + +If you want to test your new V-pipe installation, we strongly encourage you to instead check our tutorials which provide real example data. + +Tutorials for your first steps with V-pipe for different scenarios are available in the [docs/](../../docs/README.md) sub-directory. diff --git a/README.md b/README.md index d915b61c..4eb3cbac 100644 --- a/README.md +++ b/README.md @@ -31,12 +31,11 @@ general: Also see [snakemake's documentation](https://snakemake.readthedocs.io/en/stable/executing/cli.html) to learn more about the command-line options available when executing the workflow. -Tutorials introducing usage of V-pipe are available in the [docs/](docs/README.md) subdirectory. - ### Tutorials -Tutorials for your first steps with V-pipe for different scenarios are available in the [docs/](docs/README.md) subdirectory. +Tutorials for your first steps with V-pipe for different scenarios are available in the [docs/](docs/README.md) subdirectory. + ### Using quick install script diff --git a/tests/README.md b/tests/README.md index ea87a581..76dec17e 100644 --- a/tests/README.md +++ b/tests/README.md @@ -1,3 +1,9 @@ -This tests in this directory are not run routinely. +This directory contains small test datasets which are used for the automated testing of V-pipe as part of the development process. -The workflow tests that are automatically performed upon each update on GitHub can be found at https://github.com/cbg-ethz/V-pipe/tree/master/.github/workflows. +The workflow tests that are automatically performed upon each update on GitHub can be found in the [`.github/workflows` directory](../.github/workflows). + +### Tutorials + +If you want to test your new V-pipe installation, we strongly encourage you to instead check our tutorials which provide real example data. + +Tutorials for your first steps with V-pipe for different scenarios are available in the [docs/](../docs/README.md) subdirectory.