Skip to content

Commit

Permalink
mirroring install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
holtjma committed Mar 10, 2023
1 parent c3eb2c6 commit e559285
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ We are still tweaking the input / output file formats and making changes that ca
* [Latest release with binary](https://github.com/PacificBiosciences/HiPhase/releases/latest)

## Documentation
* [Installation instructions](docs/install.md)
* [User guide with quickstart](docs/user_guide.md)
* [Output files](docs/user_guide.md#output-files)
* [Methods](docs/methods.md)
Expand Down
22 changes: 22 additions & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Installing HiPhase
## Instructions
1. Navigate to the [latest release](https://github.com/PacificBiosciences/HiPhase/releases/latest) and download the tarball file (e.g. `hiphase-{version}-x86_64-unknown-linux-gnu.tar.gz`).
2. Decompress the tar file.
3. (Optional) Verify the md5 checksum.
4. Test the binary file by running it with the help option (`-h`).
5. Visit the [User guide](./user_guide.md) for details on running HiPhase.

## Example with v0.7.2
```bash
# modify this to update the version
VERSION="v0.7.2"
# get the release file
wget https://github.com/PacificBiosciences/HiPhase/releases/download/${VERSION}/hiphase-${VERSION}-x86_64-unknown-linux-gnu.tar.gz
# decompress the file into folder ${VERSION}
tar -xzvf hiphase-${VERSION}-x86_64-unknown-linux-gnu.tar.gz
cd hiphase-${VERSION}-x86_64-unknown-linux-gnu
# optional, check the md5 sum
md5sum -c hiphase.md5
# execute help instructions
./hiphase -h
```

0 comments on commit e559285

Please sign in to comment.