Ensembl / WiggleTools

Basic operations on the space of numerical functions defined on the genome using lazy evaluators for flexibility and efficiency
Apache License 2.0
142 stars 24 forks source link

README: Instructions miss to initialize HTSlib submodules #80

Closed paulmenzel closed 2 years ago

paulmenzel commented 2 years ago

https://github.com/Ensembl/WiggleTools/blob/b082056006db4738dcfd42c8fb76be47748b419d/README.md?plain=1#L56-L62

The above instructions miss to initialize the submodules as documented by HTSlib:

https://github.com/samtools/htslib/blob/f307dfbf5c7723956e788e0bdab269fe3d626b83/INSTALL#L66-L72

sgiorgetti commented 2 years ago

Dear @paulmenzel ,

Thank you for your interest in Wiggletools, and for flagging this up to us.

For the records, and while waiting for the PR, please find below a couple of ways to fix this.

After having clones the htslib repo

cd htslib
git submodule update --init --recursive
make install

Or even before cloning the htslib repo, to install the htslib library

git clone --recurse-submodules https://github.com/samtools/htslib.git
cd htslib
make install
dzerbino commented 2 years ago

Hello both,

Thanks for the report and the fix, the PR was just merged.

Regards,

Daniel

paulmenzel commented 2 years ago

@sgiorgetti, thank you for documenting the instructions also in this issue.

@all, thank you for the quick improvement done by merge/pull request https://github.com/Ensembl/WiggleTools/pull/81.

PS: If you add the tag

Resolves: https://github.com/Ensembl/WiggleTools/issues/80

GitHub is going to link the issue and merge/pull request and automatically close the issue, once the merge/pull request is submitted.