Skip to content

Commit

Permalink
fix docs comments
Browse files Browse the repository at this point in the history
Co-authored-by: Anton Korobeynikov <anton@korobeynikov.info>
  • Loading branch information
andrewprzh and asl committed May 31, 2024
1 parent ad9a26a commit 4d25048
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/binspreader.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<destination_dir>/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 `<destination_dir>/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
Expand Down
4 changes: 2 additions & 2 deletions docs/pathracer.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**).
Expand Down
2 changes: 1 addition & 1 deletion docs/spaligner.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 4d25048

Please sign in to comment.