Skip to content

Commit

Permalink
Dev install instructions, typo fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
bede committed Nov 27, 2024
1 parent f22113e commit eb1730c
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Kindel reconciles substitutions and CIGAR-described indels to to produce a major
## Limitations

- Intended for use with small alignments of e.g. virus genomes. Expect slow performance with megabase genomes.
- SAM/BAM files must contain an SQ header line with reference sequence(s) length.
- SAM/BAM files must contain an SQ header line with reference sequence length(s).
- Realignment mode (`--realign`) is able to close gaps of up to 2x read length given ample depth of coverage.


Expand All @@ -53,7 +53,9 @@ pip install kindel
For a local development install:

```
pip install --editable '.[dev]' # pip install kindel '.[dev]'
git clone https://github.com/bede/kindel.git
cd kindel
pip install --editable '.[dev]'
```


Expand Down

0 comments on commit eb1730c

Please sign in to comment.