From 1a0b5b9c9e64760b5f18d98506fa9a83a9f20533 Mon Sep 17 00:00:00 2001 From: Martin von Zweigbergk Date: Sat, 26 Feb 2022 18:10:08 -0800 Subject: [PATCH] docs: mention user-specific config path on different platforms Since #85, we load the user's config from a path under `dirs::config_dir()`. It's probably not obvious to all users where to put the file, so let's describe that. (I didn't know where to put the file on my Mac until I looked at the function's documentation.) --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b9becb894..1dc5f06e5 100644 --- a/README.md +++ b/README.md @@ -148,8 +148,10 @@ $ source <(jj debug completion) # --bash is the default ``` You may also want to configure your name and email so commits are made in your -name. Create a file at `${XDG_CONFIG_HOME}/jj/config.toml` or `~/.jjconfig` and -make it look something like this: +name. Create a file at `/jj/config.toml` (where `` is +`${XDG_CONFIG_HOME}` or `~/.config/` on Linux, `~/Library/Application Support/` +on macOS, and `~\AppData\Roaming\` on Windows) or `~/.jjconfig` and make it +look something like this: ```shell script $ cat ~/.jjconfig [user]