lee/bottom
1
0
Fork 0
mirror of https://github.com/ClementTsang/bottom.git synced 2026-05-29 18:20:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update README and autocomplete docs (#1699)

Browse Source 
* formatting

* update autocomplete
This commit is contained in:
Clement Tsang
2025-03-21 05:21:04 -04:00
committed by GitHub
parent 40087d1203
commit a90490fe83
4 changed files with 40 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/index.md
+1 -1
View File
@@ -33,7 +33,7 @@ The command to run bottom is `btm`.
You can refer to the [usage](usage/general-usage.md) pages for more details on using bottom (e.g. keybinds, some features, a general overview of what each widget does).
To configure bottom (e.g. how it behaves, how it looks, etc.) refer to the [command-line options page](configuration/command-line-options.md) for temporary settings, or [the config file page](configuration/config-file) for more permanent settings.
To configure bottom (e.g. how it behaves, how it looks, etc.) refer to the [command-line options page](configuration/command-line-options.md) for temporary settings, or [the config file page](configuration/config-file/index.md) for more permanent settings.
## Contribution
docs/content/usage/autocomplete.md
+14
View File
@@ -0,0 +1,14 @@
# Auto-Complete
The release binaries in [the releases page](https://github.com/ClementTsang/bottom/releases) are packaged with
shell auto-completion files for Bash, Zsh, fish, Powershell, Elvish, Fig, and Nushell. To install them:
- For Bash, move `btm.bash` to `$XDG_CONFIG_HOME/bash_completion or /etc/bash_completion.d/`.
- For Zsh, move `_btm` to one of your `$fpath` directories.
- For fish, move `btm.fish` to `$HOME/.config/fish/completions/`.
- For PowerShell, add `_btm.ps1` to your PowerShell [profile](<https://docs.microsoft.com/en-us/previous-versions//bb613488(v=vs.85)>).
- For Elvish, the completion file is `btm.elv`.
- For Fig, the completion file is `btm.ts`.
- For Nushell, source `btm.nu`.
The individual auto-completion files are also included in the stable/nightly releases as `completion.tar.gz` if needed.
docs/mkdocs.yml
+1
View File
@@ -161,6 +161,7 @@ nav:
- "Disk Widget": usage/widgets/disk.md
- "Temperature Widget": usage/widgets/temperature.md
- "Battery Widget": usage/widgets/battery.md
- "Auto-Complete": usage/autocomplete.md
- "Configuration":
- "Command-line Options": configuration/command-line-options.md
- "Config File":