Skip to content

Commit

Permalink
adding more information to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
guilhermesena1 committed Dec 22, 2020
1 parent 831f88d commit 33d37e6
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ install the most recent release of `falco` by running:
conda install -c bioconda falco
```

`falco` can be found inside the `bin` directory of your anaconda
installer.

## Installing from source (code release)

Compilation from source can be done by downloading a `falco` release from the
Expand All @@ -33,6 +36,9 @@ the `--prefix` argument when running `./configure`, for instance:
$ ./configure CXXFLAGS="-O3 -Wall" --prefix=/path/to/installation/directory
```

The `falco` binary will be found in the `bin` directory inside the
specified prefix.

## Installing from a cloned repository
We strongly recommend using `falco` through stable releases as described above,
as the latest commits might contain undocumented bugs. For the more
Expand All @@ -49,7 +55,8 @@ $ make all
$ make install
```

This should create a `bin` directory
This should create a `bin` directory inside the cloned repository
containing `falco`.
### Required C++ dependencies

[zlib](https://zlib.net) is required to read gzip compressed FASTQ files. It is
Expand Down

0 comments on commit 33d37e6

Please sign in to comment.