From eaf9868c11415d6bf92e717698f443f7d422ba5c Mon Sep 17 00:00:00 2001 From: Thomas O'Donnell Date: Sun, 21 Feb 2021 10:02:41 +0100 Subject: [PATCH] docs(config): Clarify the changing starship config (#2339) Have clarified changing the starship config file using the `STARSHIP_CONFIG` env var. --- docs/config/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/config/README.md b/docs/config/README.md index 3a82c5e0..b1888625 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