Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mohsenzakeri authored Apr 30, 2024
1 parent 484243e commit e559576
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@

## What is Puffaligner <a name="puffaligner"></a>

### Important note: To obtain alignments with the cigar strings (Puffaligner), please ensure you switch to the [`cigar-strings`](https://github.com/COMBINE-lab/pufferfish/tree/cigar-strings) branch before compiling the code.

Puffaligner is a fast, sensitive and accurate aligner built on top of the [Pufferfish index](#whatis).
It tries to occupy a less-well-explored position in the space of read aligners, typically
using more memory than BWT-based approaches (unless there are _highly_ repetitive references), but
Expand Down Expand Up @@ -66,6 +68,11 @@ To build the pufferfish/puffaligner do the following,
> make
```

### Important note: To obtain alignments with the cigar strings (Puffaligner), please ensure you switch to the [`cigar-strings`](https://github.com/COMBINE-lab/pufferfish/tree/cigar-strings) branch before compiling the code:
```
> git checkout cigar-strings
```

## How to Use <a name="using"></a>

**Programs used within pufferfish**
Expand Down

0 comments on commit e559576

Please sign in to comment.