Skip to content

Commit

Permalink
adding instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
leomrtns committed Aug 13, 2020
1 parent a656e78 commit 786ffce
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,15 @@ __Leonardo de Oliveira Martins<sup>1</sup>__
Tatajuba (_Bagassa guianensis_) is a South American tree, also known as Tatajubá, Tatajuva, Garrote, Totajuba.
If I'm not mistaken it means "yellow fire" in [Tupi](https://en.wikipedia.org/wiki/Tupi_language).

## Installation
You should download this repository with `git clone --recursive` to ensure it also downloads
[biomcmc-lib](https://github.com/quadram-institute-bioscience/biomcmc-lib).

This sofware uses `autotools`, so you can install it with `configure` + `make`. I'll add more instructions later, but
remember to define where you want it installed with `configure --prefix=DIR`.
It will compile from the directories `biomcmc-lib`, `kalign`, and `bwa` before finally compiling `tatajuba`.
Notice that this does **not** generate the usual executables for `kalign` or `bwa` (only their libraries are used here).

## License
SPDX-License-Identifier: GPL-3.0-or-later

Expand All @@ -19,5 +28,5 @@ This is free software; you can redistribute it and/or modify it under the terms
License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later
version (http://www.gnu.org/copyleft/gpl.html).

Tatajubá contains code from [bwa](https://github.com/lh3/bwa) and [kalign](https://github.com/TimoLassmann/kalign.git),
Tatajubá contains code from [bwa](https://github.com/lh3/bwa) by Heng Li and [kalign](https://github.com/TimoLassmann/kalign.git) by Timo Lassmann,
both released under a GPL-3.0 license.

0 comments on commit 786ffce

Please sign in to comment.