Simple, fast, safe, compiled language for developing maintainable software. Compiles itself in <1s with zero library dependencies. https://vlang.io
 
 
Go to file
Delyan Angelov b50f7fdc71
ci: simplify ci_sanitized.yml again; use `v.exe fmt -verify vlib/builtin` for windows/msvc instead of `v test-cleancode`
2022-05-15 10:54:31 +03:00
.ctags.d .ctags.d/v.ctags: upgrade syntax for latest Universal Ctags 5.9.0(7f84a443) 2020-11-28 01:05:16 +02:00
.github ci: simplify ci_sanitized.yml again; use `v.exe fmt -verify vlib/builtin` for windows/msvc instead of `v test-cleancode` 2022-05-15 10:54:31 +03:00
cmd fmt: remove space in front of ? and ! (#14366) 2022-05-13 06:56:21 +03:00
doc fmt: remove space in front of ? and ! (#14366) 2022-05-13 06:56:21 +03:00
examples examples: fix 2048 scaling on Android (#14380) 2022-05-15 09:14:18 +03:00
thirdparty fmt: remove space in front of ? and ! (#14366) 2022-05-13 06:56:21 +03:00
tutorials/building_a_simple_web_blog_with_vweb fmt: remove space in front of ? and ! (#14366) 2022-05-13 06:56:21 +03:00
vlib ci: add a skip list in compiler_test.v (for tmpl_parse_html.vv) 2022-05-15 10:23:13 +03:00
.cirrus.yml ci: entirely delete the `Code CI / arm64-ubuntu-tcc` Cirrus job, since it does not honor `trigger_type: manual`, but simply timeouts after severah hours, showing fake positives in the github CI 2022-03-30 16:00:01 +03:00
.editorconfig scanner: multibyte rune literals now support unicode, hex, and octal escape codes (#13140) 2022-01-19 03:23:25 +03:00
.gitattributes tools: modify .gitattributes to categorize *.vsh and v.mod files properly (#13674) 2022-03-07 18:15:18 +02:00
.gitignore tools: include `vls.log` in the .gitignore files for new V projects (#12522) 2021-11-19 19:23:35 +02:00
CHANGELOG.md parser,checker: support `$compile_error('message')` and `$compile_warn('message')` (#14320) 2022-05-09 08:18:26 +03:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2019-10-06 04:43:48 +03:00
CONTRIBUTING.md docs: cleanup (#14327) 2022-05-07 20:18:42 +03:00
Dockerfile Dockerfile: add support for USE_LOCAL (#10953) 2021-07-25 14:37:26 +03:00
Dockerfile.alpine Dockerfile.alpine: copy source, instead of cloning the repo (#10916) 2021-07-24 16:01:32 +03:00
Dockerfile.cross bootstrap: remove -I ./thirdparty/stdatomic/nix from make files (#14111) 2022-04-21 00:12:50 +03:00
GNUmakefile make files: add a `make check` target, that runs `v test-all` locally 2022-05-01 13:38:30 +03:00
LICENSE all: update copyright to 2019-2021 (#8029) 2021-01-18 13:20:06 +01:00
Makefile make files: add a `make check` target, that runs `v test-all` locally 2022-05-01 13:38:30 +03:00
README.md ci: wrap the too long line in README.md that failed `./v check-md -hide-warnings .` 2022-05-04 21:19:57 +03:00
ROADMAP.md docs: update urls in roadmap (#13509) 2022-02-18 14:19:06 +02:00
TESTS.md tests: add a vlib/v/tests/known_errors/known_errors_test.v test runner 2022-04-03 12:54:22 +03:00
make.bat make files: add a `make check` target, that runs `v test-all` locally 2022-05-01 13:38:30 +03:00
v.mod 0.2.4 2021-08-30 22:25:14 +03:00

README.md

The V Programming Language

vlang.io | Docs | Changelog | Speed | Contributing & compiler design

Sponsor Patreon Discord Twitter

Key Features of V

  • Simplicity: the language can be learned in less than an hour
  • Fast compilation: ≈110k loc/s with a Clang backend, ≈1 million loc/s with native and tcc backends (Intel i5-7500, SSD, no optimization) (demo video)
  • Easy to develop: V compiles itself in less than a second
  • Performance: as fast as C (V's main backend compiles to human-readable C)
  • Safety: no null, no globals, no undefined behavior, immutability by default
  • C to V translation
  • Hot code reloading
  • Innovative memory management (demo video)
  • Cross-platform UI library
  • Built-in graphics library
  • Easy cross-compilation
  • REPL
  • Built-in ORM
  • Built-in web framework
  • C and JavaScript backends
  • Great for writing low-level software (Vinix OS)

Stability guarantee and future changes

Despite being at an early development stage, the V language is relatively stable and has backwards compatibility guarantee, meaning that the code you write today is guaranteed to work a month, a year, or five years from now.

There still may be minor syntax changes before the 1.0 release, but they will be handled automatically via vfmt, as has been done in the past.

The V core APIs (primarily the os module) will still have minor changes until they are stabilized in V 1.0. Of course the APIs will grow after that, but without breaking existing code.

Unlike many other languages, V is not going to be always changing, with new features being introduced and old features modified. It is always going to be a small and simple language, very similar to the way it is right now.

Installing V - from source (preferred method)

Linux, macOS, Windows, *BSD, Solaris, WSL, Android, etc.

Usually installing V is quite simple if you have an environment that already has a functional git installation.

  • ( PLEASE NOTE: If you run into any trouble or you have a different operating system or Linux distribution that doesn't install or work immediately, please see Installation Issues and search for your OS and problem. If you can't find your problem, please add it to an existing discussion if one exists for your OS, or create a new one if a main discussion doesn't yet exist for your OS.)

To get started, simply try to execute the following in your terminal/shell:

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

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, so make sure you use the cmd.exe terminal.)

Now you can try ./v run examples/hello_world.v (v.exe on Windows).

V is constantly being updated. To update V, simply run:

v up

C compiler

It's recommended to use Clang, GCC, or Visual Studio. If you are doing development, you most likely already have one of those installed.

Otherwise, follow these instructions:

However, if none is found when running make on Linux or Windows, TCC is downloaded as the default C backend. It's very lightweight (several MB) so this shouldn't take too long.

Symlinking

NB: it is highly recommended, that you put V on your PATH. That saves you the effort to type in the full path to your v executable every time. V provides a convenience v symlink command to do that more easily.

On Unix systems, it creates a /usr/local/bin/v symlink to your executable. To do that, run:

sudo ./v symlink

On Windows, start a new shell with administrative privileges, for example by Windows Key, then type cmd.exe, right-click on its menu entry, and choose Run as administrator. In the new administrative shell, cd to the path, where you have compiled v.exe, then type:

.\v.exe symlink

That will make V available everywhere, by adding it to your PATH. Please restart your shell/editor after that, so that it can pick the new PATH variable.

NB: there is no need to run v symlink more than once - v will continue to be available, even after v up, restarts, and so on. You only need to run it again, if you decide to move the V repo folder somewhere else.

Docker

Expand Docker instructions
git clone https://github.com/vlang/v
cd v
docker build -t vlang .
docker run --rm -it vlang:latest

Docker with Alpine/musl

git clone https://github.com/vlang/v
cd v
docker build -t vlang --file=Dockerfile.alpine .
docker run --rm -it vlang:latest

Testing and running the examples

Make sure V can compile itself:

v self
$ v
V 0.2.x
Use Ctrl-C or `exit` to exit

>>> println('hello world')
hello world
>>>
cd examples
v hello_world.v && ./hello_world    # or simply
v run hello_world.v                 # this builds the program and runs it right away

v run word_counter/word_counter.v word_counter/cinderella.txt
v run news_fetcher.v
v run tetris/tetris.v

NB: In order to build Tetris or 2048 (or anything else using sokol or gg graphics modules) on some Linux systems, you need to install libxi-dev and libxcursor-dev .

V net.http, net.websocket, v install

If you plan to use the net.http module, or the net.websocket module, you also need to install OpenSSL on non-Windows systems:

macOS:
brew install openssl

Debian/Ubuntu:
sudo apt install libssl-dev

Arch/Manjaro:
openssl is installed by default

Fedora:
sudo dnf install openssl-devel

V sync

V's sync module and channel implementation uses libatomic. It is most likely already installed on your system, but if not, you can install it, by doing the following:

MacOS: already installed

Debian/Ubuntu:
sudo apt install libatomic1

Fedora/CentOS/RH:
sudo dnf install libatomic-static

V UI

https://github.com/vlang/ui

Android graphical apps

With V's vab tool, building V UI and graphical apps for Android can become as easy as:

./vab /path/to/v/examples/2048

https://github.com/vlang/vab.

Developing web applications

Check out the Building a simple web blog tutorial and Gitly, a light and fast alternative to GitHub/GitLab:

https://github.com/vlang/gitly

Vinix, an OS/kernel written in V

V is great for writing low-level software like drivers and kernels. Vinix is an OS/kernel that already runs bash, GCC, V, and nano.

https://github.com/vlang/vinix

Troubleshooting

Please see the Troubleshooting section on our wiki page