Skip to content

Commit f993b5c

Browse files
authored
Add note about XDG_DATA_HOME (#244)
May be overkill to add this but I did hit this and it took me a couple minutes to find out where it was coming from
1 parent 1eaf3a7 commit f993b5c

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,13 @@ Run tests:
126126
SEQREPO_DATAPROXY_URI=seqrepo+file:///usr/local/share/seqrepo/latest
127127
```
128128

129+
The wags-tails library also uses XDG_DATA_HOME/XDG_DATA_DIRS, which can vary by platform, terminal, and shell settings. If you see an error about writing to `/usr/` or an application data directory, it may be related to this. For example if XDG_DATA_DIRS is not set, the `ghostty` terminal sets it automatically and the value it may set it to may not exist or be writable by your user account. An easy fix is to add to your shell startup script (e.g. ~/.bashrc, ~/.zshrc, etc) and set these variables to some location in your user home directory.
130+
131+
```shell
132+
export XDG_DATA_HOME="$HOME/.local/share"
133+
export XDG_DATA_DIRS="$XDG_DATA_HOME:$XDG_DATA_DIRS"
134+
```
135+
129136
6. Finally, run tests with the following command:
130137

131138
```shell

0 commit comments

Comments
 (0)