Skip to content

Update README.md: Note to mac users regarding startup file. #261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
HotwheelsSisyphus wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md: Note to mac users regarding startup file. #261

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading