Skip to content

Commit c48138d

Browse files
committed
add installation instructions
1 parent e6ba16d commit c48138d

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,28 @@
22

33
Cross platform nvm that doesn't suck™
44

5+
## Installation
6+
7+
### Binaries
8+
9+
1. Download binary for your OS from the [Releases](https://github.com/BeeeQueue/nvm-rust/releases)
10+
2. Rename the file to `nvm` and place it somewhere in your `$PATH`
11+
3. Enjoy?
12+
13+
#### Note for Windows
14+
15+
_It does not allow creating the symlinks this program uses without either Admin access or Developer Mode._
16+
17+
_Either run the program as Administrator or [enable Developer Mode](https://docs.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development#active-developer-mode)_
18+
19+
_[Read more about it here](https://blogs.windows.com/windowsdeveloper/2016/12/02/symlinks-windows-10)_
20+
21+
### Cargo
22+
23+
```shell
24+
cargo install nvm-rust
25+
```
26+
527
## Feature Comparison
628

729
| | **nvm-rust** | [nvm-windows](https://github.com/coreybutler/nvm-windows) | [nvm](https://github.com/nvm-sh/nvm) |
@@ -15,8 +37,6 @@ Cross platform nvm that doesn't suck™
1537
| Caching ||||
1638
| Aliases ||||
1739

18-
19-
2040
**not supported, might work?
2141

2242
### Range Matching

0 commit comments

Comments
 (0)