Skip to content

Commit

Permalink
docs: streamline the installation instructions and notes for Windows …
Browse files Browse the repository at this point in the history
…and Ubuntu
  • Loading branch information
spytheman committed Aug 18, 2024
1 parent 18eee34 commit 3965a6c
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,27 +75,28 @@ language, very similar to the way it is right now.
Usually, installing V is quite simple if you have an environment that already has a
functional `git` installation.

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

To get started, execute the following in your terminal/shell:
```bash
git clone https://github.com/vlang/v
cd v
make
# HINT: Using Windows? run make.bat in a cmd shell, or ./make.bat in PowerShell
```

That should be it and you should find your V executable at `[path to V repo]/v`.
That should be it, and you should find your V executable at `[path to V repo]/v`.
`[path to V repo]` can be anywhere.

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

Now you can try `./v run examples/hello_world.v` (or `v run examples/hello_world.v` in cmd shell).
Now try running `./v run examples/hello_world.v` (or `v run examples/hello_world.v` in cmd shell).

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

V is constantly being updated. To update V, simply run:
Note: V is being constantly updated. To update V to its latest version, simply run:

```bash
v up
Expand Down
5 changes: 3 additions & 2 deletions doc/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,15 @@ Anything you can do in other languages, you can do in V.

The best way to get the latest and greatest V, is to install it from source.
It is easy, and it takes only a few seconds:

```bash
git clone https://github.com/vlang/v
cd v
make
# HINT: Using Windows?: run make.bat in the cmd.exe shell
```

Note: If you are on windows, outside of WSL, run `make.bat` instead of `make`, in a CMD shell.
Note: On Ubuntu/Debian, you may need to run `sudo apt install git build-essential make` first.

For more details, see the
[Installing V](https://github.com/vlang/v/blob/master/README.md#installing-v-from-source)
section in the README.md.
Expand Down

0 comments on commit 3965a6c

Please sign in to comment.