Skip to content

Commit

Permalink
Clarify location of config files on Windows/macOS
Browse files Browse the repository at this point in the history
  • Loading branch information
kugland committed Dec 7, 2024
1 parent 8417d67 commit fccdfbd
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,28 @@ and is not endorsed by Neocities.

## Configuration

The configuration file is a TOML file. It should be located at
`~/.config/neocities-deploy/config.toml`. A configuration file might look like
this:
The configuration file is a TOML file.

### Location of the configuration

The location of the configuration file varies with the platform you’re
using. (See the documentation for the `config_dir` function in the Rust
package called [directories](https://docs.rs/directories/latest/directories/struct.ProjectDirs.html#method.config_dir)
for clarification.)

On **Linux**, `$XDG_CONFIG_HOME/neocities-deploy/config.toml`
(or `$HOME/.config/neocities-deploy/config.toml` if `$XDG_CONFIG_HOME` is
not defined). For example: `/home/alice/.config/neocities-deploy/config.toml`.

On **macOS**, `$HOME/Library/Application Support/neocities-deploy/config.toml`.
For example, `/Users/Alice/Library/Application Support/neocities-deploy/config.toml`.

On **Windows**, `{FOLDERID_RoamingAppData}\neocities-deploy\config\config.toml`.
For example, `C:\Users\Alice\AppData\Roaming\neocities-deploy\config\config.toml`.

### Example configuration

A configuration file might look like this:

```toml
[site."site1"]
Expand Down

0 comments on commit fccdfbd

Please sign in to comment.