1
0
mirror of https://github.com/vlang/v.git synced 2023-08-10 21:13:21 +03:00
v/README.md

225 lines
6.1 KiB
Markdown
Raw Normal View History

2020-04-19 21:46:18 +03:00
<div align="center">
<p>
2020-04-13 06:11:56 +03:00
<img width="80" src="https://raw.githubusercontent.com/donnisnoni95/v-logo/master/dist/v-logo.svg?sanitize=true">
</p>
2020-04-19 21:46:18 +03:00
<h1>The V Programming Language</h1>
2019-06-22 21:22:41 +03:00
2020-04-13 06:11:56 +03:00
[vlang.io](https://vlang.io) |
2020-04-19 21:47:36 +03:00
[Docs](https://github.com/vlang/v/blob/master/doc/docs.md) |
2020-04-13 06:11:56 +03:00
[Changelog](https://github.com/vlang/v/blob/master/CHANGELOG.md) |
2020-04-17 19:25:55 +03:00
[Speed](https://fast.vlang.io/) |
[Contributing](https://github.com/vlang/v/blob/master/CONTRIBUTING.md)
2020-04-13 06:11:56 +03:00
</div>
<div align="center">
2019-06-22 21:22:41 +03:00
2020-04-19 21:46:18 +03:00
[![Build Status][WorkflowBadge]][WorkflowUrl]
[![Sponsor][SponsorBadge]][SponsorUrl]
[![Patreon][PatreonBadge]][PatreonUrl]
[![Discord][DiscordBadge]][DiscordUrl]
[![Twitter][TwitterUrl]][TwitterBadge]
2019-06-23 17:13:56 +03:00
2020-04-13 06:11:56 +03:00
</div>
2019-06-22 21:22:41 +03:00
2019-06-24 17:04:19 +03:00
## Key Features of V
2019-08-12 11:00:29 +03:00
- Simplicity: the language can be learned in less than an hour
2019-09-07 14:50:12 +03:00
- Fast compilation: ≈100k — 1.2 million loc/s
2019-06-24 17:07:41 +03:00
- Easy to develop: V compiles itself in less than a second
2019-08-12 11:00:29 +03:00
- Performance: within 3% of C
2019-06-28 02:54:42 +03:00
- Safety: no null, no globals, no undefined behavior, immutability by default
2019-06-24 17:04:19 +03:00
- C to V translation
2019-06-24 17:36:30 +03:00
- Hot code reloading
2020-01-12 22:30:21 +03:00
- [Cross-platform UI library](https://github.com/vlang/ui)
- Built-in graphics library
2019-06-24 17:04:19 +03:00
- Easy cross compilation
- REPL
2019-08-20 17:35:11 +03:00
- Built-in ORM
2019-09-07 14:50:12 +03:00
- C and JavaScript backends
2019-06-24 17:04:19 +03:00
2020-05-01 15:44:06 +03:00
A stable 0.2 release is planned for May 2020. Right now V is in an alpha stage.
2019-06-24 17:04:19 +03:00
2019-06-22 21:22:41 +03:00
## Installing V from source
2019-09-30 15:45:05 +03:00
### Linux, macOS, Windows, *BSD, Solaris, WSL, Android, Raspbian
2019-06-22 21:22:41 +03:00
```bash
git clone https://github.com/vlang/v
2019-06-29 13:58:52 +03:00
cd v
make
2019-06-26 00:02:25 +03: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 09:21:59 +03:00
(On Windows `make` means running `make.bat`, so make sure you use `cmd.exe`.)
After the above, you can try doing: `./v run examples/hello_world.v` on Unix,
or `.\v.exe run examples\hello_world.v` on Windows.
2019-10-31 14:40:17 +03:00
V is being constantly updated. To update V, simply run:
2019-09-01 22:56:49 +03:00
```
v up
```
### C compiler
2019-09-01 23:15:47 +03: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 15:59:34 +03: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 23:15:47 +03:00
- [Installing a C compiler on Windows](https://github.com/vlang/v/wiki/Installing-a-C-compiler-on-Windows)
2019-09-01 22:56:49 +03:00
### Symlinking
2019-06-23 14:27:43 +03:00
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 everytime.
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:
2019-06-22 21:22:41 +03:00
2019-10-15 09:03:21 +03:00
```bash
2019-09-11 15:32:40 +03:00
sudo ./v symlink
2019-06-22 21:22:41 +03:00
```
On Windows, start a new shell with administrative privileges, for
example by <kbd>Windows Key</kbd>, 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:
```bat
2020-05-31 09:02:27 +03:00
.\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.
2019-08-27 04:17:50 +03:00
### Docker
2019-07-23 03:41:55 +03:00
2020-01-12 22:30:21 +03:00
<details><summary>Expand Docker instructions</summary>
2019-07-23 03:41:55 +03: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 23:32:29 +03:00
2019-11-28 11:46:52 +03: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 22:30:21 +03:00
</details>
2019-11-28 11:46:52 +03:00
2019-08-12 10:54:35 +03:00
### Testing and running the examples
Make sure V can compile itself:
2019-06-22 21:22:41 +03:00
```
v -o v2 cmd/v
2019-08-12 10:54:35 +03:00
```
2019-06-22 21:22:41 +03:00
2019-10-15 09:03:21 +03:00
```bash
2019-06-26 18:58:59 +03:00
$ v
2019-06-30 16:26:03 +03:00
V 0.1.x
Use Ctrl-C or `exit` to exit
2019-06-22 21:22:41 +03:00
>>> println('hello world')
hello world
>>>
```
2019-10-15 09:03:21 +03:00
```bash
2019-08-12 11:00:29 +03:00
cd examples
2019-06-26 19:04:10 +03: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 21:22:41 +03:00
v word_counter.v && ./word_counter cinderella.txt
2019-06-24 18:13:02 +03:00
v run news_fetcher.v
2019-07-22 05:57:55 +03:00
v run tetris/tetris.v
2019-06-22 21:22:41 +03:00
```
2019-06-23 17:16:55 +03: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 03:13:33 +03:00
2019-08-27 04:17:50 +03:00
If you plan to use the http package, you also need to install OpenSSL on non-Windows systems.
2019-06-22 21:22:41 +03:00
```
2019-06-26 19:04:10 +03:00
macOS:
2019-08-10 12:51:55 +03:00
brew install glfw freetype openssl
2019-06-25 21:48:34 +03:00
2019-08-09 11:17:56 +03:00
Debian/Ubuntu:
sudo apt install libglfw3 libglfw3-dev libfreetype6-dev libssl-dev
2019-06-22 21:22:41 +03:00
2019-08-09 11:17:56 +03:00
Arch/Manjaro:
2019-08-10 12:51:55 +03:00
sudo pacman -S glfw-x11 freetype2
2019-08-09 11:17:56 +03:00
Fedora:
2019-08-10 12:51:55 +03:00
sudo dnf install glfw glfw-devel freetype-devel
Windows:
v setup-freetype
2019-06-22 21:22:41 +03:00
```
2019-06-24 19:53:22 +03:00
2019-08-10 12:51:55 +03:00
glfw dependency will be removed soon.
2019-07-22 17:07:37 +03:00
2020-01-12 22:30:21 +03:00
## V UI
<a href="https://github.com/vlang/ui">
2020-01-19 14:40:44 +03:00
<img src='https://raw.githubusercontent.com/vlang/ui/master/examples/screenshot.png' width=712>
2020-01-12 22:30:21 +03:00
</a>
https://github.com/vlang/ui
2019-12-12 20:22:11 +03:00
<!---
2019-09-15 04:10:12 +03:00
## JavaScript backend
[examples/hello_v_js.v](examples/hello_v_js.v):
2019-10-15 09:01:56 +03:00
```v
2019-09-15 04:10:12 +03:00
fn main() {
for i in 0..3 {
2019-09-15 04:10:12 +03:00
println('Hello from V.js')
}
}
```
```bash
v -o hi.js examples/hello_v_js.v && node hi.js
2019-09-15 04:10:12 +03:00
Hello from V.js
Hello from V.js
Hello from V.js
```
2019-12-12 20:22:11 +03:00
-->
## Troubleshooting
2020-05-22 18:43:39 +03:00
Please see the [Troubleshooting](https://github.com/vlang/v/wiki/Troubleshooting) section on our [wiki page](https://github.com/vlang/v/wiki)
2020-04-19 21:46:18 +03:00
[WorkflowBadge]: https://github.com/vlang/v/workflows/CI/badge.svg
[DiscordBadge]: https://img.shields.io/discord/592103645835821068?label=Discord&logo=discord&logoColor=white
[PatreonBadge]: https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.herokuapp.com%2Fvlang%2Fpledges&label=Patreon
[SponsorBadge]: https://camo.githubusercontent.com/da8bc40db5ed31e4b12660245535b5db67aa03ce/68747470733a2f2f696d672e736869656c64732e696f2f7374617469632f76313f6c6162656c3d53706f6e736f72266d6573736167653d254532253944254134266c6f676f3d476974487562
[TwitterBadge]: https://twitter.com/v_language
[WorkflowUrl]: https://github.com/vlang/v/commits/master
[DiscordUrl]: https://discord.gg/vlang
[PatreonUrl]: https://patreon.com/vlang
[SponsorUrl]: https://github.com/sponsors/medvednikov
[TwitterUrl]: https://img.shields.io/twitter/follow/v_language.svg?style=flatl&label=Follow&logo=twitter&logoColor=white&color=1da1f2