Skip to content

Commit b324859

Browse files
Document non-windows support.
Closes #169
1 parent 9983e73 commit b324859

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

docs/installation.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,38 @@
11
# Installation
22

33

4-
```
5-
$ python3 -m pip install bio2zarr
4+
```bash
5+
python3 -m pip install bio2zarr
66
```
77

8-
This will install the programs ``vcf2zarr``, ``plink2zarr`` and ``vcf_partition``
8+
This will install the programs ``vcf2zarr`` and ``vcf_partition``
99
into your local Python path. You may need to update your $PATH to call the
1010
executables directly.
1111

1212
Alternatively, calling
13-
```
14-
$ python3 -m bio2zarr vcf2zarr <args>
13+
```bash
14+
python3 -m bio2zarr vcf2zarr <args>
1515
```
1616
is equivalent to
1717

18-
```
19-
$ vcf2zarr <args>
18+
```bash
19+
vcf2zarr <args>
2020
```
2121
and will always work.
2222

2323

24+
:::{warning}
25+
Windows is not currently supported. Please comment on
26+
[this issue](https://github.com/sgkit-dev/bio2zarr/issues/174) if you would
27+
like to see Windows support for bio2zarr.
28+
:::
29+
30+
2431
## Shell completion
2532

2633
To enable shell completion for a particular session in Bash do:
2734

28-
```
35+
```bash
2936
eval "$(_VCF2ZARR_COMPLETE=bash_source vcf2zarr)"
3037
```
3138

0 commit comments

Comments
 (0)