Skip to content

Commit 37a2407

Browse files
committed
Improve Readme by copilot
Signed-off-by: Chen Su <[email protected]>
1 parent 6e6f9eb commit 37a2407

File tree

1 file changed

+45
-48
lines changed

1 file changed

+45
-48
lines changed

README.md

Lines changed: 45 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,12 @@
88

99
English | [简体中文](./README-CN.md)
1010

11-
Dvm is a lightweight, and powerful [Deno](https://deno.land/) version manager for MacOS, Linux, WSL, and Windows with Bash.
11+
DVM is a lightweight and powerful [Deno](https://deno.land/) version manager for macOS, Linux, WSL, and Windows with Bash.
1212

13-
For Windows users, you must install DVM v0.7.0 or later versions, and also need to install a bash shell if you want to use this tool. For example, you can install WSL and execute `bash` command in PowerShell.
13+
**Note for Windows users:** You must install DVM v0.7.0 or later, and you also need a Bash shell to use this tool. For example, you can install WSL and run the `bash` command in PowerShell.
1414

15-
***Please do not use `deno upgrade` command to upgrade Deno after you had installed Deno with DVM.***
15+
> [!Warning]
16+
> Do not use the `deno upgrade` command to upgrade Deno after you have installed Deno with DVM.
1617
1718
- [Installing and Updating](#installing-and-updating)
1819
- [Installation](#installation)
@@ -39,19 +40,19 @@ For Windows users, you must install DVM v0.7.0 or later versions, and also need
3940

4041
There are two ways to install DVM.
4142

42-
1. Install dvm from network by the following command:
43+
1. Install DVM from the network using the following command:
4344

4445
```sh
4546
curl -o- "https://raw.githubusercontent.com/ghosind/dvm/master/install.sh" | bash
4647
```
4748

48-
For Chinese user, you can also install it from Gitee by the following command:
49+
For users in China, you can install DVM from Gitee using the following command:
4950

5051
```sh
5152
curl -o- "https://gitee.com/ghosind/dvm/raw/master/install.sh" | DVM_SOURCE=gitee bash
5253
```
5354

54-
2. Clone this project and execute `install.sh` script:
55+
2. Clone this project and execute the `install.sh` script:
5556

5657
```sh
5758
git clone "https://github.com/ghosind/dvm.git"
@@ -61,9 +62,9 @@ cd dvm
6162
./install.sh
6263
```
6364

64-
After installed dvm, please restart your terminal or use `source <your_rc_file>` to apply changes.
65+
After installing DVM, restart your terminal or run `source <your_profile_file>` to apply the changes.
6566

66-
The default install location is `~/.dvm`, you can use `-d <dir>` option (for local install only) or `$DVM_DIR` environment variable to specify an inexistent directory as the install location.
67+
The default installation location is `~/.dvm`. You can use the `-d <dir>` option (for local installs only) or the `$DVM_DIR` environment variable to specify a different directory.
6768

6869
```sh
6970
curl -o- "https://raw.githubusercontent.com/ghosind/dvm/master/install.sh" | DVM_DIR=~/deno/dvm bash
@@ -72,24 +73,24 @@ curl -o- "https://raw.githubusercontent.com/ghosind/dvm/master/install.sh" | DVM
7273

7374
### Upgrade DVM
7475

75-
Since DVM `v0.3.0`, we provided `upgrade` command to update your DVM to the latest version.
76+
Since DVM `v0.3.0`, the `upgrade` command is available to update DVM to the latest version.
7677

7778
```sh
7879
dvm upgrade
7980
```
8081

81-
If you want to update the DVM that less than `v0.3.0`, you may need to uninstall the current version and re-install the latest version. You can get the uninstall steps from [Manual uninstall](#manual-uninstall) section.
82+
If you are using a DVM version older than `v0.3.0`, you may need to uninstall the current version and reinstall the latest one. See the [Manual uninstall](#manual-uninstall) section for instructions.
8283

83-
## Prerequirement
84+
## Prerequisites
8485

85-
Please make sure you have required dependencies installed:
86+
Please ensure you have the following dependencies installed:
8687

8788
- curl
8889
- git
8990
- unzip (for Deno v0.36.0 and newer versions)
9091
- gunzip (for Deno v0.35.0 and lower versions)
9192

92-
For installing Deno from source, please make sure you have required dependencies installed:
93+
To install Deno from source, you will also need:
9394

9495
- rustc
9596
- cargo
@@ -98,11 +99,11 @@ For installing Deno from source, please make sure you have required dependencies
9899

99100
## Getting Started
100101

101-
After installed dvm, you can use it to manage multiple version Deno environments.
102+
After installing DVM, you can use it to manage multiple Deno versions and environments.
102103

103104
### List available versions
104105

105-
Use `dvm list-remote` or `dvm ls-remote` to list all available versions from remote.
106+
Use `dvm list-remote` or `dvm ls-remote` to list all available Deno versions from the remote server.
106107

107108
```sh
108109
# list all available versions
@@ -113,7 +114,7 @@ dvm ls-remote
113114

114115
### List installed versions
115116

116-
Use `dvm list` or `dvm ls` to list all installed versions.
117+
Use `dvm list` or `dvm ls` to list all installed Deno versions.
117118

118119
```sh
119120
# list all installed versions
@@ -124,64 +125,62 @@ dvm ls
124125

125126
### Install Deno
126127

127-
Use `dvm install <version>` command to download and install a specified version from the source.
128+
Use the `dvm install <version>` command to download and install a specific Deno version.
128129

129130
```sh
130131
dvm install v1.0.0
131-
# deno v1.0.0 has installed.
132-
# Using deno v1.0.0 now.
133-
132+
# Deno v1.0.0 has been installed.
133+
# Using Deno v1.0.0 now.
134134
dvm install v0.42.0
135-
# deno v0.42.0 has installed.
136-
# Using deno v1.0.0 now.
135+
# Deno v0.42.0 has been installed.
136+
# Using Deno v1.0.0 now.
137137
```
138138

139139
### Install Deno from source
140140

141-
Since DVM v0.8.0, you can install Deno from source with `--from-source` option.
141+
Since DVM v0.8.0, you can install Deno from source using the `--from-source` option.
142142

143143
```sh
144144
dvm install --from-source v1.35.0
145145
```
146146

147147
### Uninstall Deno
148148

149-
Use `dvm uninstall <version|alias-name>` command to uninstall a specified version.
149+
Use the `dvm uninstall <version|alias-name>` command to uninstall a specific version or alias.
150150

151151
```sh
152152
dvm uninstall v0.39.0
153-
# uninstalled deno v0.39.0.
154-
153+
# Uninstalled Deno v0.39.0.
155154
# default is an alias name
156155
dvm uninstall default
157-
# uninstalled deno default.
156+
# Uninstalled Deno default.
158157
```
159158

160159
### Set active version
161160

162-
Use `dvm use [version]` command to link `deno` to the specified installed version by parameter or `.dvmrc` file.
161+
Use the `dvm use [version]` command to link `deno` to the specified installed version, either by parameter or from a `.dvmrc` file.
163162

164163
```sh
165-
# use v1.0.0
164+
# Use v1.0.0
166165
dvm use v1.0.0
167-
# Using deno v1.0.0 now.
166+
# Using Deno v1.0.0 now.
168167
```
169168

170-
If you do not specify the active version, DVM will try to read `.dvmrc` file from the current working directory.
169+
If you do not specify a version, DVM will try to read the `.dvmrc` file from the current working directory.
171170

172171
```sh
173172
# cat .dvmrc
174173
# # v1.4.0
175174
dvm use
176175
# Found './dvmrc' with version v1.4.0
177-
# Using deno v1.4.0 now.
176+
# Using Deno v1.4.0 now.
178177
```
179178

180-
Set active version by `use` command is for a single terminal session only. If you want to set an active version for all terminal sessions, please set a `default` alias to a version. See [Set an alias](#set-active-version) section for more details.
179+
Setting the active version with the `use` command only affects the current terminal session. To set a default version for all terminal sessions, create a `default` alias. See the [Set an alias](#set-active-version) section for more details.
181180

182181
### Get current version
183182

184-
Use `dvm current` command to display the current version of Deno.
183+
Use the `dvm current` command to display the currently active Deno version.
185184

186185
```sh
187186
dvm current
@@ -190,24 +189,22 @@ dvm current
190189

191190
### Set an alias
192191

193-
Use `dvm alias` command to set alias name for a installed version of Deno.
192+
Use the `dvm alias` command to set an alias for an installed Deno version.
194193

195194
```sh
196195
dvm ls
197196
# v1.0.0
198-
199-
# Set an alias
197+
# Set the default alias
200198
dvm alias default v1.0.0
201199
# default -> v1.0.0
202-
203200
dvm ls
204201
# v1.0.0
205202
# default -> v1.0.0
206203
```
207204

208205
### Run with a version
209206

210-
Use `dvm run` command to run Deno on the specified version with arguments.
207+
Use the `dvm run` command to run Deno with the specified version and arguments.
211208

212209
```sh
213210
dvm run v1.0.0
@@ -217,7 +214,7 @@ dvm run v1.0.0
217214
# >
218215
```
219216

220-
You can also run a script file with the specified version.
217+
You can also run a script file with the specified Deno version.
221218

222219
```sh
223220
# Run app.ts with Deno v1.0.0
@@ -226,7 +223,7 @@ dvm run v1.0.0 app.ts
226223

227224
## Commands
228225

229-
DVM supported the following commands:
226+
DVM supports the following commands:
230227

231228
| Command | Usage | Description |
232229
|:-------:|:-----:|:------------|
@@ -260,7 +257,7 @@ DVM supported the following commands:
260257
| `purge` | `dvm purge` | Remove dvm from your computer. |
261258
| `help` | `dvm help` | Show dvm help message. |
262259

263-
Please visit [dvm wiki](https://github.com/ghosind/dvm/wiki) for more details.
260+
For more details, please visit the [DVM Wiki](https://github.com/ghosind/dvm/wiki).
264261

265262
### Options
266263

@@ -273,23 +270,23 @@ Please visit [dvm wiki](https://github.com/ghosind/dvm/wiki) for more details.
273270

274271
## Uninstalling DVM
275272

276-
There are two ways to remove DVM from your computer.
273+
You can remove DVM from your computer in two ways:
277274

278275
### Use `purge` command
279276

280-
You can execute `dvm purge` to remove dvm from your computer if your dvm version is `v0.3.2` and above. It will remove the `$DVM_DIR` and dvm configurations in shell config file.
277+
You can run `dvm purge` to remove DVM from your computer if your DVM version is `v0.3.2` or above. This will remove the `$DVM_DIR` and DVM configuration from your shell config file.
281278

282-
If your dvm is less than `v0.3.2`, please following the next section ([Manual uninstall](#manual-uninstall)) to remove DVM.
279+
If your DVM version is older than `v0.3.2`, please follow the next section ([Manual uninstall](#manual-uninstall)) to remove DVM.
283280

284281
### Manual uninstall
285282

286-
You can also execute following command to uninstall dvm:
283+
Alternatively, you can run the following command to uninstall DVM:
287284

288285
```sh
289286
rm -rf "$DVM_DIR"
290287
```
291288

292-
Edit shell config file (like `.bashrc` or `.zshrc`), and remove the following lines:
289+
Edit your shell config file (such as `.bashrc` or `.zshrc`) and remove the following lines:
293290

294291
```sh
295292
# Deno Version Manager
@@ -300,4 +297,4 @@ export DVM_DIR="$HOME/.dvm"
300297

301298
## License
302299

303-
Distributed under the MIT License. See LICENSE file for more information.
300+
Distributed under the MIT License. See the LICENSE file for more information.

0 commit comments

Comments
 (0)