Skip to content

Commit 3965a6c

Browse files
committed
docs: streamline the installation instructions and notes for Windows and Ubuntu
1 parent 18eee34 commit 3965a6c

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

README.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -75,27 +75,28 @@ language, very similar to the way it is right now.
7575
Usually, installing V is quite simple if you have an environment that already has a
7676
functional `git` installation.
7777

78-
To get started, simply try to execute the following in your terminal/shell:
78+
Note: On Windows, run `make.bat` instead of `make` in CMD, or `./make.bat` in PowerShell.
79+
Note: On Ubuntu/Debian, you may need to run `sudo apt install git build-essential make` first.
7980

81+
To get started, execute the following in your terminal/shell:
8082
```bash
8183
git clone https://github.com/vlang/v
8284
cd v
8385
make
84-
# HINT: Using Windows? run make.bat in a cmd shell, or ./make.bat in PowerShell
8586
```
8687

87-
That should be it and you should find your V executable at `[path to V repo]/v`.
88+
That should be it, and you should find your V executable at `[path to V repo]/v`.
8889
`[path to V repo]` can be anywhere.
8990

90-
(As in the hint above, on Windows `make` means running `make.bat`.)
91+
(Like the note above says, on Windows, use `make.bat`, instead of `make`.)
9192

92-
Now you can try `./v run examples/hello_world.v` (or `v run examples/hello_world.v` in cmd shell).
93+
Now try running `./v run examples/hello_world.v` (or `v run examples/hello_world.v` in cmd shell).
9394

94-
- *Trouble? Please see the note above and link to
95+
- *Trouble? Please see the notes above, and link to
9596
[Installation Issues](https://github.com/vlang/v/discussions/categories/installation-issues)
9697
for help.*
9798

98-
V is constantly being updated. To update V, simply run:
99+
Note: V is being constantly updated. To update V to its latest version, simply run:
99100

100101
```bash
101102
v up

doc/docs.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,15 @@ Anything you can do in other languages, you can do in V.
2121

2222
The best way to get the latest and greatest V, is to install it from source.
2323
It is easy, and it takes only a few seconds:
24-
2524
```bash
2625
git clone https://github.com/vlang/v
2726
cd v
2827
make
29-
# HINT: Using Windows?: run make.bat in the cmd.exe shell
3028
```
3129

30+
Note: If you are on windows, outside of WSL, run `make.bat` instead of `make`, in a CMD shell.
31+
Note: On Ubuntu/Debian, you may need to run `sudo apt install git build-essential make` first.
32+
3233
For more details, see the
3334
[Installing V](https://github.com/vlang/v/blob/master/README.md#installing-v-from-source)
3435
section in the README.md.

0 commit comments

Comments
 (0)