docs: update the getting started guide
All checks were successful
REUSE Compliance Check / check (push) Successful in 5s
All checks were successful
REUSE Compliance Check / check (push) Successful in 5s
This commit is contained in:
parent
d38431d9e8
commit
61a00d7a5b
1 changed files with 2 additions and 3 deletions
|
@ -8,7 +8,8 @@ Follow along to log into your own account.
|
||||||
|
|
||||||
## Your configuration directory
|
## Your configuration directory
|
||||||
|
|
||||||
Enbas uses Go's [os.UserConfigDir()](https://pkg.go.dev/os#UserConfigDir) function to calculate the location of your configuration directory.
|
You can use the `--config-dir` global flag to specify the path to your configuration directory.
|
||||||
|
Alternatively Enbas tries to set the directory based on your home configuration directory using Go's [os.UserConfigDir()](https://pkg.go.dev/os#UserConfigDir) function.
|
||||||
|
|
||||||
If you've set the `XDG_CONFIG_HOME` environment variable, the configuration directory will be set to `$XDG_CONFIG_HOME/enbas`.
|
If you've set the `XDG_CONFIG_HOME` environment variable, the configuration directory will be set to `$XDG_CONFIG_HOME/enbas`.
|
||||||
|
|
||||||
|
@ -18,8 +19,6 @@ If this is not set, then:
|
||||||
- on Darwin (MacOS) the configuration directory will be set to `$HOME/Library/Application Support/enbas`.
|
- on Darwin (MacOS) the configuration directory will be set to `$HOME/Library/Application Support/enbas`.
|
||||||
- on Windows the configuration directory will be set within the `%AppData%` directory.
|
- on Windows the configuration directory will be set within the `%AppData%` directory.
|
||||||
|
|
||||||
Alternatively you can use the `--config-dir` global flag to specify your configuration directory.
|
|
||||||
|
|
||||||
## Generate your configuration file
|
## Generate your configuration file
|
||||||
|
|
||||||
Run the `init` command to generate your configuration file.
|
Run the `init` command to generate your configuration file.
|
||||||
|
|
Loading…
Reference in a new issue