Skip to content

Commit 1ea3a59

Browse files
authored
Update README.md
1 parent 7396ff2 commit 1ea3a59

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ SCAPP assembles plasmids from metagenomic assembly graphs.
66
* [With Conda](#with-conda)
77
* [From sources](#from-sources)
88
- [Configuring paths to required executables](#configuring-paths-to-required-executables)
9+
- [Testing your SCAPP installation](#testing-your-scapp-installation)
910
- [Basic Usage](#basic-usage)
1011
- [Main output files](#main-output-files)
1112
- [Advanced usage](#advanced-usage)
@@ -68,6 +69,11 @@ The BWA, samtools, and BLAST+ executables must be available to SCAPP. They can e
6869

6970
For example, if the BWA executable is in `/usr/bin/bwa/` then the line `"BWA_PATH" : "/usr/bin/bwa",` should be completed in the `config.json` file if that location is not in your `PATH`.
7071

72+
##### Testing your SCAPP installation
73+
Once you have completed the above you can run `./run_test.sh` from the outermost SCAPP directory to test your installation.
74+
75+
(If the test fails please ensure you have set up the environment, installed, and configured SCAPP as described. Open an issue on this GitHub page with any problems you run into.)
76+
7177
## Basic Usage
7278
To run the SCAPP pipeline:
7379
```

0 commit comments

Comments
 (0)