Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added documentation on global variables for config file and data directory. #24

Closed
wants to merge 1 commit into from
Closed

Added documentation on global variables for config file and data directory. #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions src/cli.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand All @@ -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")
Expand Down