From dc93dd70d99e17a5cec7e451398711006347b485 Mon Sep 17 00:00:00 2001 From: mantheflan Date: Wed, 10 Feb 2021 15:39:52 +0100 Subject: [PATCH] Added documentation on global variables for config file and data directory. --- README.md | 4 ++-- src/cli.rs | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ca6eb90..c8f5796 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ Let me know if you want to package flavours for your favorite distro. Just install cargo and run `cargo install flavours` (don't forget to include `~/.cargo/bin` on your PATH). #### Post-install -After installing, you should probably use `flavours update all` to grab all published schemes and templates from the base16 repos. If you want, you can manually tweak the templates, schemes or even the repo lists (everything's located in `~/.local/share/flavours` on Linux). +After installing, you should probably use `flavours update all` to grab all published schemes and templates from the base16 repos. If you want, you can manually tweak the templates, schemes or even the repo lists (everything's located in `~/.local/share/flavours` on Linux, can be changed using the `FLAVOURS_DATA_DIRECTORY` global variable). ### Usage You can use flavours and base16 templates to automatically inject schemes into any application config file that supports colors codes. @@ -55,7 +55,7 @@ For reference, here's a couple configuration files from my [dots](https://github - [rofi](https://github.com/Misterio77/dotfiles/blob/master/home/.config/rofi/themes/styles/colors.rasi) (rewrite mode) -On flavours configuration (`~/.config/flavours/config.toml` on Linux): +On flavours configuration (`~/.config/flavours/config.toml` on Linux, can be changed using the `FLAVOURS_CONFIG_FILE` global variable): - Create a `[[item]]` section for each app, each section can have the following entries: - Specify the `file` to write (required) - A `template` (required) diff --git a/src/cli.rs b/src/cli.rs index 2819683..fa297b0 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -19,7 +19,7 @@ pub fn build_cli() -> App<'static> { ) .arg( Arg::new("config") - .about("Specify a configuration file (Defaults to ~/.config/flavours/config.toml on Linux)") + .about("Specify a configuration file (Defaults to ~/.config/flavours/config.toml on Linux, can be changed using the FLAVOURS_CONFIG_FILE global variable)") .long("config") .short('c') .value_name("FILE") @@ -28,7 +28,7 @@ pub fn build_cli() -> App<'static> { ) .arg( Arg::new("directory") - .about("Specify a data directory (Defaults to ~/.local/share/flavours on Linux)") + .about("Specify a data directory (Defaults to ~/.local/share/flavours on Linux, can be changed using the FLAVOURS_DATA_DIRECTORY global variable)") .long("directory") .short('d') .value_name("DIRECTORY")