summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorThomas O'Donnell <andytom@users.noreply.github.com>2021-02-21 10:02:41 +0100
committerGitHub <noreply@github.com>2021-02-21 10:02:41 +0100
commiteaf9868c11415d6bf92e717698f443f7d422ba5c (patch)
tree113b3327c95bc064888de070a96977033a0a4a89
parent71b6fc17777bd587199a6c1b2c7e30e1a87535f7 (diff)
docs(config): Clarify the changing starship config (#2339)
Have clarified changing the starship config file using the `STARSHIP_CONFIG` env var.
-rw-r--r--docs/config/README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/config/README.md b/docs/config/README.md
index 3a82c5e05..b18886251 100644
--- a/docs/config/README.md
+++ b/docs/config/README.md
@@ -21,16 +21,16 @@ success_symbol = "[➜](bold green)" # The "success_symbol" segment is being
disabled = true
```
-You can change default `starship.toml` file location with `STARSHIP_CONFIG` environment variable:
+You can change default configuration file location with `STARSHIP_CONFIG` environment variable:
```sh
-export STARSHIP_CONFIG=~/.starship
+export STARSHIP_CONFIG=~/.starship/config.toml
```
Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`:
```powershell
-$ENV:STARSHIP_CONFIG = "$HOME\.starship"
+$ENV:STARSHIP_CONFIG = "$HOME\.starship\config.toml"
```
### Logging