Skip to content

Commit db10b6d

Browse files
authored
MAINT: adds architecture specific install instructions into README template (#36)
1 parent d31ad00 commit db10b6d

1 file changed

Lines changed: 37 additions & 1 deletion

File tree

template/{{ package_name }}/README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,42 @@ Once you have the directory on your computer, change (`cd`) into it.
3131
If you're in a conda environment, deactivate it by running `conda deactivate`.
3232

3333

34-
Then, run:
34+
Then, follow the install instructions below, based on your machine's architecture:
35+
36+
<details>
37+
<summary><strong>🍏&nbsp;Apple Silicon (ARM)</strong></summary>
38+
<p>&nbsp;</p>
39+
40+
Start by creating a new conda environment:
41+
42+
```shell
43+
CONDA_SUBDIR=osx-64 conda env create -n {{ package_name }}-dev --file ./environment-files/{{ package_name }}-qiime2-{{ target_distro }}-dev.yml
44+
```
45+
46+
After this completes, activate the new environment you created by running:
47+
48+
```shell
49+
conda activate {{ package_name }}-dev
50+
```
51+
52+
Once this new environment has been activated, update your conda config to set the subdir to osx-64:
53+
54+
```shell
55+
conda config --env --set subdir osx-64
56+
```
57+
58+
Finally, run:
59+
60+
```shell
61+
make install
62+
```
63+
</details>
64+
65+
<details>
66+
<summary><strong>🛠&nbsp;All other architectures (Apple Intel, Linux, WSL)</strong></summary>
67+
<p>&nbsp;</p>
68+
69+
Start by creating a new conda environment:
3570

3671
```shell
3772
conda env create -n {{ package_name }}-dev --file ./environment-files/{{ package_name }}-qiime2-{{ target_distro }}-dev.yml
@@ -48,6 +83,7 @@ Finally, run:
4883
```shell
4984
make install
5085
```
86+
</details>
5187

5288
## Testing and using the most recent development version of `{{ package_name }}`
5389

0 commit comments

Comments
 (0)