Skip to content

Commit

Permalink
add contributing docs and install script
Browse files Browse the repository at this point in the history
  • Loading branch information
mbhall88 committed Apr 6, 2023
1 parent 9d3daf1 commit 456fd9f
Show file tree
Hide file tree
Showing 5 changed files with 520 additions and 1 deletion.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

[![codecov](https://codecov.io/gh/mbhall88/drprg/branch/main/graph/badge.svg?token=2WAA6MZRKK)](https://codecov.io/gh/mbhall88/drprg)
[![Rust](https://github.com/mbhall88/drprg/actions/workflows/rust.yml/badge.svg?branch=main)](https://github.com/mbhall88/drprg/actions/workflows/rust.yml)
[![github release version](https://img.shields.io/github/v/release/mbhall88/drprg)](https://github.com/mbhall88/drprg/releases)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Full documentation: <https://mbh.sh/drprg/>

Expand Down
3 changes: 3 additions & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,6 @@
- [VCF to build reference graph](./guide/build/vcf.md)
- [Catalogue of mutations](./guide/build/catalogue.md)
- [Expert rules](./guide/build/expert.md)

[Contributing](./contributing.md)
[Changes](../../CHANGELOG.md)
7 changes: 7 additions & 0 deletions docs/src/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Contributing

If you would like to contribute to Dr. PRG, feel free to open a pull request with
suggested changes, or even raise an issue to discuss potential contributions.

If you would like to contribute a prebuilt index for a species, head on over
to https://github.com/mbhall88/drprg-index
58 changes: 57 additions & 1 deletion docs/src/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## Conda

[![Conda (channel only)](https://img.shields.io/conda/vn/bioconda/drprg)](https://anaconda.org/bioconda/drprg)
[![bioconda version](https://anaconda.org/bioconda/drprg/badges/platforms.svg)](https://anaconda.org/bioconda/drprg)
![Conda](https://img.shields.io/conda/dn/bioconda/drprg)

```
conda install drprg
```
Expand Down Expand Up @@ -37,6 +41,59 @@ To run `drprg` using the above container with [Singularity]
$ singularity exec "docker://$URI" drprg --help
```

## Prebuilt binary

If you use the prebuilt binary, you must have the [external dependecies](#dependencies) installed separately.

```shell
curl -sSL drprg.mbh.sh | sh
# or with wget
wget -nv -O - drprg.mbh.sh | sh
```

You can also pass options to the script like so

```
$ curl -sSL drprg.mbh.sh | sh -s -- --help
install.sh [option]
Fetch and install the latest version of drprg, if drprg is already
installed it will be updated to the latest version.
Options
-V, --verbose
Enable verbose output for the installer
-f, -y, --force, --yes
Skip the confirmation prompt during installation
-p, --platform
Override the platform identified by the installer
-b, --bin-dir
Override the bin installation directory [default: /usr/local/bin]
-a, --arch
Override the architecture identified by the installer [default: x86_64]
-B, --base-url
Override the base URL used for downloading releases [default: https://github.com/mbhall88/drprg/releases]
-h, --help
Display this help message
```


## Cargo

[![Crates.io](https://img.shields.io/crates/v/drprg.svg)](https://crates.io/crates/drprg)

If install via cargo, you must have the [external dependecies](#dependencies) installed separately.

```
$ cargo install drprg
```

## Local

**Minimum supported Rust version**: `1.65.0`
Expand Down Expand Up @@ -76,7 +133,6 @@ changed by specifying a path to `EXTDIR` when installing the external dependenci
$ just deps EXTDIR="some/other/dir"
```


[pandora]: https://github.com/rmcolq/pandora
[mafft]: https://mafft.cbrc.jp/alignment/software/
[makeprg]: https://github.com/leoisl/make_prg/
Expand Down
Loading

0 comments on commit 456fd9f

Please sign in to comment.