Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Rob Patro committed Jul 16, 2024
1 parent b14d990 commit d6926cb
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,16 @@ The `simpleaf` program can be installed from source, from [crates.io](https://cr

Check out the detailed documentation [here](https://simpleaf.readthedocs.io/en/latest/), and read on below to learn more about the background and motivation behind `simpleaf`.

## Note

- **Please ensure that the user file handle limit is set to 2048**. This may already be set (and should be fine already on OSX), but you can accomplish this by executing:

```
$ ulimit -n 2048
```

before running `simpleaf`.

## Introduction & motivation

* **Q(s)** : What is the purpose of `simpleaf`? Isn't its functionality covered by the constituent programs (e.g. `salmon`, `alevin-fry`, `piscem`, etc.)? Can't I make those tools do the same things `simpleaf` does?
Expand Down

0 comments on commit d6926cb

Please sign in to comment.