v/README.md

202 lines
5.0 KiB
Markdown
Raw Normal View History

2019-11-12 19:37:23 +01:00
<img width="80" src="https://raw.githubusercontent.com/donnisnoni95/v-logo/master/dist/v-logo.svg?sanitize=true">
# The V Programming Language
2019-06-22 20:22:41 +02:00
2019-09-22 09:06:15 +02:00
[![Build Status](https://github.com/vlang/v/workflows/CI/badge.svg)](https://github.com/vlang/v/commits/master)
2019-08-20 16:29:06 +02:00
<a href='https://patreon.com/vlang'><img src='https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.herokuapp.com%2Fvlang%2Fpledges&style=for-the-badge' height='20'></a>
2020-01-15 21:47:02 +01:00
[![Twitter handle][]][Twitter badge]
2019-06-22 20:22:41 +02:00
https://vlang.io
2019-09-22 09:06:15 +02:00
Documentation: [vlang.io/docs](https://vlang.io/docs)
2019-06-22 20:22:41 +02:00
2019-12-04 11:40:46 +01:00
Changelog: [github.com/vlang/v/blob/master/CHANGELOG.md](https://github.com/vlang/v/blob/master/CHANGELOG.md)
2019-11-22 03:21:19 +01:00
Speed Test: [fast.vlang.io](https://fast.vlang.io/) (monitors compilation speed for each commit to verify there are no speed regressions)
2019-09-22 09:06:15 +02:00
Twitter: [twitter.com/v_language](https://twitter.com/v_language)
2019-06-22 20:22:41 +02:00
2020-02-08 12:23:29 +01:00
Discord (primary community): [discord.gg/vlang](https://discord.gg/vlang)
2019-06-24 02:04:58 +02:00
2019-09-22 09:06:15 +02:00
Installing V: [github.com/vlang/v#installing-v-from-source](https://github.com/vlang/v#installing-v-from-source)
2019-06-23 16:13:56 +02:00
2019-06-22 20:22:41 +02:00
2019-06-24 16:04:19 +02:00
## Key Features of V
2019-08-12 10:00:29 +02:00
- Simplicity: the language can be learned in less than an hour
2019-09-07 13:50:12 +02:00
- Fast compilation: ≈100k — 1.2 million loc/s
2019-06-24 16:07:41 +02:00
- Easy to develop: V compiles itself in less than a second
2019-08-12 10:00:29 +02:00
- Performance: within 3% of C
2019-06-28 01:54:42 +02:00
- Safety: no null, no globals, no undefined behavior, immutability by default
2019-06-24 16:04:19 +02:00
- C to V translation
2019-06-24 16:36:30 +02:00
- Hot code reloading
2020-01-12 20:30:21 +01:00
- [Cross-platform UI library](https://github.com/vlang/ui)
- Built-in graphics library
2019-06-24 16:04:19 +02:00
- Easy cross compilation
- REPL
2019-08-20 16:35:11 +02:00
- Built-in ORM
2019-09-07 13:50:12 +02:00
- C and JavaScript backends
2019-06-24 16:04:19 +02:00
A stable 0.2 release is planned for March 2020. Right now V is in an alpha stage.
2019-06-24 16:04:19 +02:00
2019-06-22 20:22:41 +02:00
## Installing V from source
2019-09-30 14:45:05 +02:00
### Linux, macOS, Windows, *BSD, Solaris, WSL, Android, Raspbian
2019-06-22 20:22:41 +02:00
```bash
git clone https://github.com/vlang/v
2019-06-29 12:58:52 +02:00
cd v
make
2019-06-25 23:02:25 +02:00
```
That's it! Now you have a V executable at `[path to V repo]/v`. `[path to V repo]` can be anywhere.
2019-10-22 08:21:59 +02:00
(On Windows `make` means running `make.bat`, so make sure you use `cmd.exe`.)
2019-10-31 12:40:17 +01:00
V is being constantly updated. To update V, simply run:
2019-09-01 21:56:49 +02:00
```
v up
```
### C compiler
2019-09-01 22:15:47 +02:00
You'll need Clang or GCC or Visual Studio. If you are doing development, you most likely already have one of those installed.
2019-10-05 14:59:34 +02:00
Otherwise, follow these instructions:
- [Installing a C compiler on Linux and macOS](https://github.com/vlang/v/wiki/Installing-a-C-compiler-on-Linux-and-macOS)
2019-09-01 22:15:47 +02:00
- [Installing a C compiler on Windows](https://github.com/vlang/v/wiki/Installing-a-C-compiler-on-Windows)
2019-09-01 21:56:49 +02:00
### Symlinking
2019-06-23 13:27:43 +02:00
2019-08-12 09:49:20 +02:00
You can create a `/usr/local/bin/v` symlink so that V is globally available:
2019-06-22 20:22:41 +02:00
2019-10-15 08:03:21 +02:00
```bash
2019-09-11 14:32:40 +02:00
sudo ./v symlink
2019-06-22 20:22:41 +02:00
```
2019-08-27 03:17:50 +02:00
### Docker
2019-07-23 02:41:55 +02:00
2020-01-12 20:30:21 +01:00
<details><summary>Expand Docker instructions</summary>
2019-07-23 02:41:55 +02:00
```bash
git clone https://github.com/vlang/v
cd v
docker build -t vlang .
docker run --rm -it vlang:latest
v
```
2019-06-27 22:32:29 +02:00
2019-11-28 09:46:52 +01:00
### Docker with Alpine/musl:
```bash
git clone https://github.com/vlang/v
cd v
docker build -t vlang --file=Dockerfile.alpine .
docker run --rm -it vlang:latest
/usr/local/v/v
```
2020-01-12 20:30:21 +01:00
</details>
2019-11-28 09:46:52 +01:00
2019-08-12 09:54:35 +02:00
### Testing and running the examples
Make sure V can compile itself:
2019-06-22 20:22:41 +02:00
```
v -o v2 cmd/v
2019-08-12 09:54:35 +02:00
```
2019-06-22 20:22:41 +02:00
2019-10-15 08:03:21 +02:00
```bash
2019-06-26 17:58:59 +02:00
$ v
2019-06-30 15:26:03 +02:00
V 0.1.x
Use Ctrl-C or `exit` to exit
2019-06-22 20:22:41 +02:00
>>> println('hello world')
hello world
>>>
```
2019-10-15 08:03:21 +02:00
```bash
2019-08-12 10:00:29 +02:00
cd examples
2019-06-26 18:04:10 +02:00
v hello_world.v && ./hello_world # or simply
v run hello_world.v # this builds the program and runs it right away
2019-06-22 20:22:41 +02:00
v word_counter.v && ./word_counter cinderella.txt
2019-06-24 17:13:02 +02:00
v run news_fetcher.v
2019-07-22 04:57:55 +02:00
v run tetris/tetris.v
2019-06-22 20:22:41 +02:00
```
2019-06-23 16:16:55 +02:00
<img src='https://raw.githubusercontent.com/vlang/v/master/examples/tetris/screenshot.png' width=300>
In order to build Tetris and anything else using the graphics module, you will need to install glfw and freetype libraries.
2019-08-02 02:13:33 +02:00
2019-08-27 03:17:50 +02:00
If you plan to use the http package, you also need to install OpenSSL on non-Windows systems.
2019-06-22 20:22:41 +02:00
```
2019-06-26 18:04:10 +02:00
macOS:
2019-08-10 11:51:55 +02:00
brew install glfw freetype openssl
2019-06-25 20:48:34 +02:00
2019-08-09 10:17:56 +02:00
Debian/Ubuntu:
sudo apt install libglfw3 libglfw3-dev libfreetype6-dev libssl-dev
2019-06-22 20:22:41 +02:00
2019-08-09 10:17:56 +02:00
Arch/Manjaro:
2019-08-10 11:51:55 +02:00
sudo pacman -S glfw-x11 freetype2
2019-08-09 10:17:56 +02:00
Fedora:
2019-08-10 11:51:55 +02:00
sudo dnf install glfw glfw-devel freetype-devel
Windows:
git clone --depth=1 https://github.com/ubawurinna/freetype-windows-binaries [path to v repo]/thirdparty/freetype/
2019-06-22 20:22:41 +02:00
```
2019-06-24 18:53:22 +02:00
2019-08-10 11:51:55 +02:00
glfw dependency will be removed soon.
2019-07-22 16:07:37 +02:00
2020-01-12 20:30:21 +01:00
## V UI
<a href="https://github.com/vlang/ui">
2020-01-19 12:40:44 +01:00
<img src='https://raw.githubusercontent.com/vlang/ui/master/examples/screenshot.png' width=712>
2020-01-12 20:30:21 +01:00
</a>
https://github.com/vlang/ui
2019-12-12 18:22:11 +01:00
<!---
2019-09-15 03:10:12 +02:00
## JavaScript backend
[examples/hello_v_js.v](examples/hello_v_js.v):
2019-10-15 08:01:56 +02:00
```v
2019-09-15 03:10:12 +02:00
fn main() {
for i in 0..3 {
2019-09-15 03:10:12 +02:00
println('Hello from V.js')
}
}
```
```bash
v -o hi.js examples/hello_v_js.v && node hi.js
2019-09-15 03:10:12 +02:00
Hello from V.js
Hello from V.js
Hello from V.js
```
2019-12-12 18:22:11 +01:00
-->
## Troubleshooting
2019-09-30 14:45:05 +02:00
https://github.com/vlang/v/wiki/Troubleshooting
2019-08-12 09:54:35 +02:00
## Contributing
Code structure:
2019-07-22 16:07:37 +02:00
https://github.com/vlang/v/blob/master/CONTRIBUTING.md
2019-08-12 09:54:35 +02:00
If you introduce a breaking change and rebuild V, you will no longer be able to use V to build itself. So it's a good idea to make a backup copy of a working compiler executable.
2020-01-15 21:47:02 +01:00
[Twitter handle]: https://img.shields.io/twitter/follow/v_language.svg?style=social&label=Follow
2020-02-07 14:31:41 +01:00
[Twitter badge]: https://twitter.com/v_language