From 2f49d9629ad0e76e60ac3de42972f7b661c89de0 Mon Sep 17 00:00:00 2001
From: Tobias Tschiedl <98126742+HotwheelsSisyphus@users.noreply.github.com>
Date: Wed, 8 Oct 2025 21:51:47 -0400
Subject: [PATCH] Update README.md: Note to mac users

regarding the Platform.userConfigDir and startup file
---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/README.md b/README.md
index e3ebdf6b..49b4f832 100644
--- a/README.md
+++ b/README.md
@@ -203,6 +203,23 @@ if (\SCNvim.asClass.notNil) {
   Server.program = (Platform.resourceDir +/+ "scsynth.exe").quote;
 }
 ```
+### Note to Mac users
+sclang will set its `Platform.userConfigDir` to XDG_CONFIG_HOME (most likely `/Users/USERNAME/.config`) if it exists, 
+and only if it does not exist, the mac `/Users/USERNAME/Library/Application Support` directory will be used.
+This means that the path to the startup and config files will likely be different in scnvim from that in the
+regular superCollider IDE. 
+
+While the path to the config file can be specified via args to sclang, e.g.:
+```lua
+local scnvim = require('scnvim')
+scnvim.setup({
+  sclang = {
+    cmd = "/Applications/SuperCollider.app/Contents/MacOS/sclang",
+    args = { "-l", "/Users/USERNAME/Library/Application Support/SuperCollider/sclang_conf.yaml" }
+  },
+})
+```
+the same appears not to be possible for the startup file and sclang's `userConfigDir` in general.
 
 ## License