Installation

Open
#464 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
build-system, c

Research direction

Start with the installation instructions at http://samtools.github.io/bcftools/howtos/install.html and inspect the section after the HTSlib note. Ensure the documented sequence includes changing to bcftools-1.x/htslib-1.x/, running make, and copying bgzip and tabix to the same bin directory; the documentation is done when a fresh reader can follow those steps without inference.

Written by the indexing model from the issue text.

Description

documentation

Hello.
The installation instruction is not full:
After "The bgzip and tabix utilities are provided by HTSlib. ... you may wish to install these utilities by hand by":

cd bcftools-1.x/htslib-1.x/
make

and only after that "by copying {bgzip,tabix} to the same bin directory to which you have installed bcftools et al."

Dominant language
C
Stars
891
Forks
277
Avg merge
2d 23h
Merged PRs (30d)
2

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from samtools/bcftools

All issues in samtools/bcftools

Similar issues

More C issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.