Skip to content

Commit

Permalink
Documentation tweaks (#599)
Browse files Browse the repository at this point in the history
* Adds link in install instructions to the command completion docs added in #597
* Small visual tweaks
  • Loading branch information
roaree authored Jan 14, 2025
1 parent 0dc6228 commit a2493ba
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
12 changes: 9 additions & 3 deletions docs/command_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,19 @@ To enable it, you need to manually register a special function with your shell,

The following describes how to generate the command completion scripts and add them to your shell configuration.

`You will need to start a new shell for the changes to take effect.`
> **Note: You will need to start a new shell for the changes to take effect.**
### For Bash

```bash
# Generates bash completion scripts
echo "$(_MVT_IOS_COMPLETE=bash_source mvt-ios)" > ~/.mvt-ios-complete.bash &&
echo "$(_MVT_ANDROID_COMPLETE=bash_source mvt-android)" > ~/.mvt-android-complete.bash
```

# Sources the scripts in ~/.bashrc.
Add the following to `~/.bashrc`:
```bash
# source mvt completion scripts
. ~/.mvt-ios-complete.bash && . ~/.mvt-android-complete.bash
```

Expand All @@ -27,8 +30,11 @@ echo "$(_MVT_ANDROID_COMPLETE=bash_source mvt-android)" > ~/.mvt-android-complet
# Generates zsh completion scripts
echo "$(_MVT_IOS_COMPLETE=zsh_source mvt-ios)" > ~/.mvt-ios-complete.zsh &&
echo "$(_MVT_ANDROID_COMPLETE=zsh_source mvt-android)" > ~/.mvt-android-complete.zsh
```

# Sources the scripts in ~/.zshrc.
Add the following to `~/.zshrc`:
```bash
# source mvt completion scripts
. ~/.mvt-ios-complete.zsh && . ~/.mvt-android-complete.zsh
```

Expand Down
4 changes: 4 additions & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,3 +98,7 @@ You now should have the `mvt-ios` and `mvt-android` utilities installed.
**Notes:**
1. The `--force` flag is necessary to force the reinstallation of the package.
2. To revert to using a PyPI version, it will be necessary to `pipx uninstall mvt` first.

## Setting up command completions

See ["Command completions"](command_completion.md)

0 comments on commit a2493ba

Please sign in to comment.