From 1b1e77a78a50b836b024843336284f01b7cc6254 Mon Sep 17 00:00:00 2001 From: Andrey Prjibelski Date: Fri, 31 May 2024 11:26:09 +0300 Subject: [PATCH] fix docs comments Co-authored-by: Anton Korobeynikov --- docs/binspreader.md | 4 ++-- docs/installation.md | 2 +- docs/pathracer.md | 4 ++-- docs/spaligner.md | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/binspreader.md b/docs/binspreader.md index 2d0adbb53..68e09f90f 100644 --- a/docs/binspreader.md +++ b/docs/binspreader.md @@ -18,13 +18,13 @@ instructions on installing and running BinSPreader. ## Compilation -To compile SPAligner, run +To compile BinSPreader, run ``` ./spades_compile -SPADES_ENABLE_PROJECTS=binspreader ``` -After the compilation is complete, `binspreader` executable will be located in the `bin/` folder. +After the compilation is complete, `binspreader` executable will be located in the `bin` folder. ## Command line options diff --git a/docs/installation.md b/docs/installation.md index f4961cb4b..fa9120150 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -88,7 +88,7 @@ for example: which will install SPAdes into `/usr/local/bin`. -After installation, you will get the same files (listed above) in `./bin` directory (or `/bin` if you specified PREFIX). We also suggest adding `bin` directory to the `PATH` variable. +After installation, you will get the same files (listed above) in `bin` directory (or `/bin` if you specified PREFIX). We also suggest adding `bin` directory to the `PATH` environment variable. ## Building additional tools SPAdes toolkit includes a number of standalone tools that are built using core diff --git a/docs/pathracer.md b/docs/pathracer.md index 77330bff4..fb3d72250 100644 --- a/docs/pathracer.md +++ b/docs/pathracer.md @@ -26,13 +26,13 @@ six frame translation + `hmmsearch` from **HMMer** package is more than enough. ## Compilation -To compile SPAligner, run +To compile PathRacer, run ``` ./spades_compile -SPADES_ENABLE_PROJECTS=pathracer ``` -After the compilation is complete, `pathracer` executable will be located in the `bin/` folder. +After the compilation is complete, `pathracer` executable will be located in the `bin` folder. ## Input Currently, the tool supports only _de Bruijn_ graphs in GFA format as produced by **SPAdes** or compatible assembler in this matter (e.g., **MEGAHIT**). diff --git a/docs/spaligner.md b/docs/spaligner.md index 950b44ec8..1d6c49fef 100644 --- a/docs/spaligner.md +++ b/docs/spaligner.md @@ -13,7 +13,7 @@ To compile SPAligner, run ./spades_compile -SPADES_ENABLE_PROJECTS=spaligner ``` -After the compilation is complete, `spaligner` executable will be located in the `bin/` folder. +After the compilation is complete, `spaligner` executable will be located in the `bin` folder. ## Running SPAligner