document XDG_CONFIG_HOME config directory change

pull/350/head
Bao Trinh 2021-09-08 07:09:01 -05:00
parent 298bbc0fe8
commit a7823dd9d6
No known key found for this signature in database
GPG Key ID: A9B3110B4EA55E36
2 changed files with 7 additions and 7 deletions

View File

@ -86,7 +86,7 @@ See [themes](https://github.com/aristocratos/bpytop/tree/master/themes) folder f
The `make install` command places the default themes in `/usr/local/share/bpytop/themes`. The `make install` command places the default themes in `/usr/local/share/bpytop/themes`.
If installed with `pip3` the themes will be located in a folder called `bpytop-themes` in the python3 site-packages folder. If installed with `pip3` the themes will be located in a folder called `bpytop-themes` in the python3 site-packages folder.
User created themes should be placed in `$HOME/.config/bpytop/themes`. User created themes should be placed in `${XDG_CONFIG_HOME:-$HOME/.config}/bpytop/themes`.
Let me know if you want to contribute with new themes. Let me know if you want to contribute with new themes.
@ -361,7 +361,7 @@ sudo make uninstall
## Configurability ## Configurability
All options changeable from within UI. All options changeable from within UI.
Config files stored in "$HOME/.config/bpytop" folder Config files stored in "${XDG_CONFIG_HOME:-$HOME/.config}/bpytop" folder
#### bpytop.cfg: (auto generated if not found) #### bpytop.cfg: (auto generated if not found)
@ -370,7 +370,7 @@ Config files stored in "$HOME/.config/bpytop" folder
```bash ```bash
#? Config file for bpytop v. 1.0.64 #? Config file for bpytop v. 1.0.64
#* Color theme, looks for a .theme file in "/usr/[local/]share/bpytop/themes" and "~/.config/bpytop/themes", "Default" for builtin default theme. #* Color theme, looks for a .theme file in "/usr/[local/]share/bpytop/themes" and "${XDG_CONFIG_HOME:-$HOME/.config}/bpytop/themes", "Default" for builtin default theme.
#* Prefix name by a plus sign (+) for a theme located in user themes folder, i.e. color_theme="+monokai" #* Prefix name by a plus sign (+) for a theme located in user themes folder, i.e. color_theme="+monokai"
color_theme="monokai" color_theme="monokai"
@ -518,7 +518,7 @@ show_init=False
#* Enable check for new version from github.com/aristocratos/bpytop at start. #* Enable check for new version from github.com/aristocratos/bpytop at start.
update_check=True update_check=True
#* Set loglevel for "~/.config/bpytop/error.log" levels are: "ERROR" "WARNING" "INFO" "DEBUG". #* Set loglevel for "${XDG_CONFIG_HOME:-$HOME/.config}/bpytop/error.log" levels are: "ERROR" "WARNING" "INFO" "DEBUG".
#* The level set includes all lower levels, i.e. "DEBUG" will show all logging info. #* The level set includes all lower levels, i.e. "DEBUG" will show all logging info.
log_level=DEBUG log_level=DEBUG

View File

@ -88,7 +88,7 @@ BANNER_SRC: List[Tuple[str, str, str]] = [
#*?This is the template used to create the config file #*?This is the template used to create the config file
DEFAULT_CONF: Template = Template(f'#? Config file for bpytop v. {VERSION}' + ''' DEFAULT_CONF: Template = Template(f'#? Config file for bpytop v. {VERSION}' + '''
#* Color theme, looks for a .theme file in "/usr/[local/]share/bpytop/themes" and "~/.config/bpytop/themes", "Default" for builtin default theme. #* Color theme, looks for a .theme file in "/usr/[local/]share/bpytop/themes" and "$${XDG_CONFIG_HOME:-$$HOME/.config}/bpytop/themes", "Default" for builtin default theme.
#* Prefix name by a plus sign (+) for a theme located in user themes folder, i.e. color_theme="+monokai" #* Prefix name by a plus sign (+) for a theme located in user themes folder, i.e. color_theme="+monokai"
color_theme="$color_theme" color_theme="$color_theme"
@ -236,7 +236,7 @@ show_init=$show_init
#* Enable check for new version from github.com/aristocratos/bpytop at start. #* Enable check for new version from github.com/aristocratos/bpytop at start.
update_check=$update_check update_check=$update_check
#* Set loglevel for "~/.config/bpytop/error.log" levels are: "ERROR" "WARNING" "INFO" "DEBUG". #* Set loglevel for "$${XDG_CONFIG_HOME:-$$HOME/.config}/bpytop/error.log" levels are: "ERROR" "WARNING" "INFO" "DEBUG".
#* The level set includes all lower levels, i.e. "DEBUG" will show all logging info. #* The level set includes all lower levels, i.e. "DEBUG" will show all logging info.
log_level=$log_level log_level=$log_level
''') ''')
@ -4271,7 +4271,7 @@ class Menu:
'', '',
'Choose from all theme files in', 'Choose from all theme files in',
'"/usr/[local/]share/bpytop/themes" and', '"/usr/[local/]share/bpytop/themes" and',
'"~/.config/bpytop/themes".', '"${XDG_CONFIG_HOME:-$HOME/.config}/bpytop/themes".',
'', '',
'"Default" for builtin default theme.', '"Default" for builtin default theme.',
'User themes are prefixed by a plus sign "+".', 'User themes are prefixed by a plus sign "+".',