Skip to content

Commit f3e4b42

Browse files
authored
Enhance README with installation and uninstallation details (#118)
Added the following text, considered the bare minimum, to the README. - Added text explaining an overview of what exactly happens to the terminal when the installation script is executed. - Added a note explaining that vLLM can be started immediately using the vllm command after the installation script completes. - Added text directing users to refer to the official guide for instructions on using the vllm command. - Added a note stating that this command is only valid if the default directory has not been changed for that part. - Added instructions on how to uninstall. Signed-off-by: chattytak <94992438+chattytak@users.noreply.github.com>
1 parent ce6bd02 commit f3e4b42

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,15 @@ vLLM Metal is a plugin that enables vLLM to run on Apple Silicon Macs using MLX
1717
- macOS on Apple Silicon
1818

1919
## Installation
20+
Using the install script, the following will be installed under the `~/.venv-vllm-metal` directory (the default).
21+
- vllm-metal plugin
22+
- vllm core
23+
- Related libraries
24+
25+
If you run `source ~/.venv-vllm-metal/bin/activate`, the `vllm` CLI becomes available and you can access the vLLM right away.
26+
27+
For how to use the `vllm` CLI, please refer to the official vLLM guide.
28+
https://docs.vllm.ai/en/latest/cli/
2029

2130
```bash
2231
curl -fsSL https://raw.githubusercontent.com/vllm-project/vllm-metal/main/install.sh | bash
@@ -25,11 +34,19 @@ curl -fsSL https://raw.githubusercontent.com/vllm-project/vllm-metal/main/instal
2534
## Reinstallation and Update
2635
If any issues occur, please use the following command to switch to the latest release version and check if the problem is resolved.
2736
If the issue continues to occur in the latest release, please report the details of the issue.
37+
(If you have installed it in a directory other than the default `~/.venv-vllm-metal`, substitute that path and run the command accordingly.)
2838

2939
```bash
3040
rm -rf ~/.venv-vllm-metal && curl -fsSL https://raw.githubusercontent.com/vllm-project/vllm-metal/main/install.sh | bash
3141
```
3242

43+
## Uninstall
44+
Please delete the directory that was installed by the installation script.
45+
(If you have installed it in a directory other than the default `~/.venv-vllm-metal`, substitute that path and run the command accordingly.)
46+
```bash
47+
rm -rf ~/.venv-vllm-metal
48+
```
49+
3350
## Architecture
3451

3552
```

0 commit comments

Comments
 (0)