From 35ce4ad1a4f38d89029e567efeb993b649aa6ff9 Mon Sep 17 00:00:00 2001
From: Xuehai Pan <XuehaiPan@pku.edu.cn>
Date: Fri, 12 Jul 2024 12:04:36 +0000
Subject: [PATCH] docs(README): add notes to set alias for `pipx run nvitop`

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/README.md b/README.md
index c88c98ae..6c4cc1d7 100644
--- a/README.md
+++ b/README.md
@@ -146,6 +146,24 @@ Run `bash install-nvidia-driver.sh --help` for more information.
 pipx run nvitop
 ```
 
+You can also set this command as an alias in your shell startup file, e.g.:
+
+```bash
+# For Bash
+echo 'alias nvitop="pipx run nvitop"' >> ~/.bashrc
+
+# For Zsh
+echo 'alias nvitop="pipx run nvitop"' >> ~/.zshrc
+
+# For Fish
+mkdir -p ~/.config/fish
+echo 'alias nvitop="pipx run nvitop"' >> ~/.config/fish/config.fish
+
+# For PowerShell
+New-Item -Path (Split-Path -Parent -Path $PROFILE.CurrentUserAllHosts) -ItemType Directory -Force
+'Function nvitop { pipx run nvitop @Args }' >> $PROFILE.CurrentUserAllHosts
+```
+
 Install from PyPI ([![PyPI](https://img.shields.io/pypi/v/nvitop?label=pypi&logo=pypi)](https://pypi.org/project/nvitop)):
 
 ```bash