Skip to content

Commit 43aa3bd

Browse files
committed
Update docs
1 parent 19825ed commit 43aa3bd

2 files changed

Lines changed: 19 additions & 3 deletions

File tree

docs-site/docs/download-and-installation.mdx

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,16 @@ See the Conda instructions in [non-containerized/README.md](https://github.com/C
6262

6363
### Method 3: From GitHub (`G`)
6464

65-
Recommended when you need the repository utilities, examples, tests, or development version.
65+
Recommended when you want the current GitHub version without waiting for a CPAN release.
6666

67-
See the GitHub checkout instructions in [non-containerized/README.md](https://github.com/CNAG-Biomedical-Informatics/pheno-ranker/blob/main/non-containerized/README.md).
67+
Install directly with `cpanm`:
68+
69+
```bash
70+
cpanm --notest https://github.com/CNAG-Biomedical-Informatics/pheno-ranker.git
71+
pheno-ranker --help
72+
```
73+
74+
Use a developer checkout only when you need to inspect the source, run tests, use local examples, or edit code locally. See the full GitHub instructions in [non-containerized/README.md](https://github.com/CNAG-Biomedical-Informatics/pheno-ranker/blob/main/non-containerized/README.md).
6875

6976
## Containerized
7077

non-containerized/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,16 @@ conda deactivate
8484

8585
## Method 3: From GitHub
8686

87-
Clone the repository:
87+
Install the current GitHub version directly with `cpanm`:
88+
89+
```bash
90+
cpanm --notest https://github.com/CNAG-Biomedical-Informatics/pheno-ranker.git
91+
pheno-ranker --help
92+
```
93+
94+
### Developer Checkout
95+
96+
Clone the repository only when you want to inspect the source code, run tests, use local examples, or edit the code locally:
8897

8998
```bash
9099
git clone https://github.com/cnag-biomedical-informatics/pheno-ranker.git

0 commit comments

Comments
 (0)