From b132bfc961a8568aeb11c5e1b85b7a88bf958744 Mon Sep 17 00:00:00 2001 From: Brice Letcher Date: Wed, 24 Jan 2024 16:14:57 +0100 Subject: [PATCH 1/2] Fix typo in README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 90bf02b..c685ddf 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ snakemake -j 16 -p --use-conda --conda-frontend mamba --ri snakemake --profile ./ebio-cluster/ ``` -### Compatablity +### Compatibility While snakemake and Acanthophis are cross-platform, most of the underlying tools are only packaged for and/or only operate on Linux `x68_64`. Therefore, I only support users on Linux systems. In theory, everything *should* run on OSX or WSL, but the vast majority of users will want to utilise a high performance linux workstation (at least, probably more likely a cluster). From 4106443cf9ba5ceedffe4087acc9f502b82d9ddb Mon Sep 17 00:00:00 2001 From: Brice Letcher Date: Wed, 24 Jan 2024 16:34:46 +0100 Subject: [PATCH 2/2] Add pointer to tests in README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index c685ddf..c5f8ce4 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,10 @@ snakemake --profile ./ebio-cluster/ While snakemake and Acanthophis are cross-platform, most of the underlying tools are only packaged for and/or only operate on Linux `x68_64`. Therefore, I only support users on Linux systems. In theory, everything *should* run on OSX or WSL, but the vast majority of users will want to utilise a high performance linux workstation (at least, probably more likely a cluster). +### Running tests + +For running tests, see [./tests/README.md](tests/README.md). + # Contribution & Assistance If you have anything (advice, docs, code) you'd like to contribute, pull requests are more than welcome. Please discuss any major contribution in a new issue before implementing it, to avoid wasted effort.