apollo/enbas
1
0
Fork 0
Code Issues 4 Pull requests Projects Activity Actions

docs: update the getting started guide
All checks were successful
REUSE Compliance Check / check (push) Successful in 5s
Details

Browse source
This commit is contained in:
Dan Anglin 2024-08-19 07:10:38 +01:00
parent d38431d9e8
commit 61a00d7a5b
Signed by: dananglin
GPG key ID: 0C1D44CFBEE68638
1 changed files with 2 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/getting_started.md
View file

@ -8,7 +8,8 @@ Follow along to log into your own account.
## 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`.
@ -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 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
Run the `init` command to generate your configuration file.