From c17d3593a88c4b4001ecc582ed02832dabbd600c Mon Sep 17 00:00:00 2001 From: microbiomes <50488790+microbiomes@users.noreply.github.com> Date: Mon, 25 Mar 2024 13:15:34 +0000 Subject: [PATCH 1/2] compile --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 68d0dfc..8f49e9f 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,32 @@ Seqfu can be easily installed via Miniconda: conda install -y -c conda-forge -c bioconda "seqfu>1.10" ``` +### Build from source + +Building the Nim programs alone would just require a `nimble build`, but this would leave out some other utilities. +There is a `make` (Makefile) building system. Since Nim is not so popular, I describe a full installation: + +```bash +# Do you have building tools? You will need C and make, in Ubuntu: +sudo apt install build-essential + +# Install zlib +sudo apt install zlib1g-dev + +# Install Nim 2.0 +curl https://nim-lang.org/choosenim/init.sh -sSf | sh + +# Clone this repo +git clone https://github.com/telatin/seqfu2 + +# Compile and test +cd seqfu2 +make +make test + +# All binaries are in bin (move them in a location in your $PATH) +``` + ## 📰 Citation Telatin A, Fariselli P, Birolo G. From d0e8ee40bd3f773a1a93103ca44eee349a4917b9 Mon Sep 17 00:00:00 2001 From: Andrea Telatin <15690844+telatin@users.noreply.github.com> Date: Mon, 25 Mar 2024 13:21:36 +0000 Subject: [PATCH 2/2] Update README.md --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8f49e9f..6929faf 100644 --- a/README.md +++ b/README.md @@ -25,8 +25,10 @@ conda install -y -c conda-forge -c bioconda "seqfu>1.10" ### Build from source -Building the Nim programs alone would just require a `nimble build`, but this would leave out some other utilities. -There is a `make` (Makefile) building system. Since Nim is not so popular, I describe a full installation: +Building the Nim programs alone would just require a `nimble build`, +but this would leave out some other utilities. +There is a `make` (Makefile) building system. Since Nim is not so popular, +I describe a full installation: ```bash # Do you have building tools? You will need C and make, in Ubuntu: