From 96849da332c809041040371b55eb5b4aaf097330 Mon Sep 17 00:00:00 2001
From: Martin von Zweigbergk <martinvonz@google.com>
Date: Sun, 8 May 2022 09:26:58 -0700
Subject: [PATCH] docs: prefer `~/.jjconfig.toml` on all platforms

It's much easier to tell users on all platforms to put their config in
`~/.jjconfig.toml` than in a path that varies across the platforms, so
let's do that. It also seems like a less controversial location for
the file.

Closes ##233.
---
 README.md        | 6 ++----
 docs/tutorial.md | 4 ++--
 2 files changed, 4 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index be740abbd..78fa0e03d 100644
--- a/README.md
+++ b/README.md
@@ -204,12 +204,10 @@ cargo install --git https://github.com/martinvonz/jj.git
 ## Initial configuration
 
 You may want to configure your name and email so commits are made in your name.
-Create a file at `<config dir>/jj/config.toml` (where `<config dir>` is
-`${XDG_CONFIG_HOME}` or `~/.config/` on Linux, `~/Library/Application Support/`
-on macOS, and `~\AppData\Roaming\` on Windows) and make it look something like
+Create a file at `~/jjconfig.toml` and make it look something like
 this:
 ```shell script
-$ cat ~/.config/jj/config.toml
+$ cat ~/.jjconfig.toml
 [user]
 name = "Martin von Zweigbergk"
 email = "martinvonz@google.com"
diff --git a/docs/tutorial.md b/docs/tutorial.md
index 8e5e55abc..ecda5c354 100644
--- a/docs/tutorial.md
+++ b/docs/tutorial.md
@@ -175,7 +175,7 @@ ancestors (`:foo`), descendants (`foo:`), DAG range (`foo:bar`, like
 `git log --ancestry-path`), range (`foo..bar`, same as Git's). There are also a
 few more functions, such as `heads(<set>)`, which filters out revisions in the
 input set if they're ancestors of other revisions in the set. Let's define an
-alias based on that by adding the following to `~/.config/jj/config.toml`:
+alias based on that by adding the following to `~/.jjconfig.toml`:
 ```
 [alias]
 l = ["log", "-r", "(heads(remote_branches())..@):"]
@@ -348,7 +348,7 @@ try `jj l --at-op=401652a2f61e` but use the hash from your own `jj op log`.
 You have already seen how `jj squash` can combine the changes from two commits
 into one. There are several other commands for changing the contents of existing
 commits. These commands assume that you have `meld` installed. If you prefer
-`vimdiff`, add this to your `~/.config/jj/config.toml` file:
+`vimdiff`, add this to your `~/.jjconfig.toml` file:
 ```
 [ui]
 diff-editor = "vimdiff"