Skip to content

Commit 9408fba

Browse files
docs: add pixi installation instructions
Add prerequisites section to README with pixi install command. Expand installation.md with platform-specific tabs and link to official pixi documentation. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 56b4b9a commit 9408fba

File tree

2 files changed

+31
-5
lines changed

2 files changed

+31
-5
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,16 @@ A Snakemake pipeline to process ONT aa-tRNA-seq data.
88

99
**[Documentation](https://rnabioco.github.io/aa-tRNA-seq-pipeline)** | **[Downstream Analysis](https://github.com/rnabioco/aa-tRNA-seq)**
1010

11+
## Prerequisites
12+
13+
This pipeline uses [Pixi](https://pixi.sh) for environment management. Install it first:
14+
15+
```bash
16+
curl -fsSL https://pixi.sh/install.sh | sh
17+
```
18+
19+
See the [Pixi installation guide](https://pixi.prefix.dev/latest/installation/) for alternative methods (Homebrew, Windows, etc.).
20+
1121
## Usage
1222

1323
The pipeline can be configured by editing the `config/config.yml` file. The config file specifications will

docs/getting-started/installation.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,34 @@ This guide covers installing the aa-tRNA-seq pipeline and its dependencies.
1111

1212
## Install Pixi
1313

14-
The pipeline uses [Pixi](https://pixi.sh) for environment management. Install it with:
14+
The pipeline uses [Pixi](https://pixi.sh) for environment management.
1515

16-
```bash
17-
curl -fsSL https://pixi.sh/install.sh | bash
18-
```
16+
=== "Linux/macOS"
17+
18+
```bash
19+
curl -fsSL https://pixi.sh/install.sh | sh
20+
```
21+
22+
=== "macOS (Homebrew)"
23+
24+
```bash
25+
brew install pixi
26+
```
27+
28+
=== "Windows"
29+
30+
```powershell
31+
powershell -ExecutionPolicy Bypass -c "irm -useb https://pixi.sh/install.ps1 | iex"
32+
```
1933

2034
After installation, restart your shell or run:
2135

2236
```bash
23-
source ~/.bashrc # or ~/.zshrc
37+
source ~/.bashrc # or ~/.zshrc for Zsh
2438
```
2539

40+
For additional installation options, see the [official Pixi installation guide](https://pixi.prefix.dev/latest/installation/).
41+
2642
## Clone the Repository
2743

2844
```bash

0 commit comments

Comments
 (0)