Skip to content

Commit e53c050

Browse files
authored
Merge pull request #4 from templateflow/platformdirs
doc: Update default directories for platformdirs
2 parents 241a086 + e0f09d5 commit e53c050

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

docs/usage/client.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,12 @@ further Internet access.
4141

4242
### Before you start
4343

44-
By default, the local cache of the archive is stored under `$HOME/.cache/templateflow`.
45-
If you need to change the location of the local copy, make sure you set the `TEMPLATEFLOW_HOME`
44+
By default, the local cache of the archive is stored in a OS-dependent, user-specific directory.
45+
This directory will be `$HOME/.cache/templateflow` (or `$XDG_CACHE_HOME/templateflow`),
46+
`$HOME/Library/Caches/templateflow`, or `%USERPROFILE%\AppData\Local\$appauthor\$appname\Cache`
47+
for Linux/Unix, MacOS, and Windows, respectively.
48+
49+
If you need to change the location of the local copy, set the `TEMPLATEFLOW_HOME`
4650
environment variable:
4751

4852
``` bash
@@ -108,10 +112,10 @@ This skeleton contains zero-size files, that are replaced by the appropriate con
108112
from S3 on the first utilization.
109113

110114
So, if you just installed the client, and want to open a particular template image with the
111-
Mango visualization tool, instead of just doing:
115+
Mango visualization tool, instead of just doing, for example:
112116

113117
``` bash
114-
$ mango ${TEMPLATEFLOW_HOME:-$HOME/.cache/templateflow}/tpl-MNI152NLin6Asym/tpl-MNI152NLin6Asym_res-01_T1w.nii.gz
118+
$ mango $TEMPLATEFLOW_HOME/tpl-MNI152NLin6Asym/tpl-MNI152NLin6Asym_res-01_T1w.nii.gz
115119
```
116120

117121
Please make sure you use the client to access the image, for instance:

0 commit comments

Comments
 (0)