diff --git a/README.md b/README.md index b1ad828..2bb3a77 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ # FusionScan Being coded... NOT ready to be used + +# Download +Get latest (may be not stable) +```shell +# download use http +https://github.com/OpenGene/FusionScan/archive/master.zip + +# or download use git +git clone https://github.com/OpenGene/FusionScan.git +``` +Get the stable releases +https://github.com/OpenGene/FusionScan/releases/latest + +# Build +FusionScan only depends on `libz`, which is always available on Linux or Mac systems. If your system has no `libz`, install it first. +```shell +cd FusionScan +make +```