mirror/v
1
0
Fork 0
mirror of https://github.com/vlang/v.git synced 2023-08-10 21:13:21 +03:00
Code Issues Projects Releases Wiki Activity

readme: minor clean up (#6055)

Browse Source
This commit is contained in:
tarunama 2020-08-11 08:07:17 +09:00 committed by GitHub
parent 1a9dba0005
commit 12d66208b8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -34,7 +34,8 @@
- Built-in graphics library - Built-in graphics library
- Easy cross compilation - Easy cross compilation
- REPL - REPL
- Built-in ORM - [Built-in ORM](https://github.com/vlang/v/blob/master/doc/docs.md#orm)
- [Built-in web framework](https://github.com/vlang/v/blob/master/vlib/vweb/README.md)
- C and JavaScript backends - C and JavaScript backends
## Stability guarantee and future changes ## Stability guarantee and future changes
@ -54,8 +55,6 @@ Unlike many other languages, V is not going to be always changing, with new feat
being introduced and old features modified. It is always going to be a small and simple 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. language, very similar to the way it is right now.
## Installing V from source ## Installing V from source
### Linux, macOS, Windows, *BSD, Solaris, WSL, Android, Raspbian ### Linux, macOS, Windows, *BSD, Solaris, WSL, Android, Raspbian
@ -75,7 +74,7 @@ Now you can try `./v run examples/hello_world.v` (`v.exe` on Windows).
V is being constantly updated. To update V, simply run: V is being constantly updated. To update V, simply run:
``` ```bash
v up v up
``` ```
@ -108,9 +107,11 @@ 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 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 entry, and choose `Run as administrator`. In the new administrative
shell, cd to the path, where you have compiled v.exe, then type: shell, cd to the path, where you have compiled v.exe, then type:
```bat ```bat
.\v.exe symlink .\v.exe symlink
``` ```
That will make v available everywhere, by adding it to your PATH. That will make v available everywhere, by adding it to your PATH.
Please restart your shell/editor after that, so that it can pick Please restart your shell/editor after that, so that it can pick
the new PATH variable. the new PATH variable.
@ -132,7 +133,8 @@ docker run --rm -it vlang:latest
v v
``` ```
### Docker with Alpine/musl: ### Docker with Alpine/musl
```bash ```bash
git clone https://github.com/vlang/v git clone https://github.com/vlang/v
cd v cd v
@ -140,14 +142,14 @@ docker build -t vlang --file=Dockerfile.alpine .
docker run --rm -it vlang:latest docker run --rm -it vlang:latest
/usr/local/v/v /usr/local/v/v
``` ```
</details>
</details>
### Testing and running the examples ### Testing and running the examples
Make sure V can compile itself: Make sure V can compile itself:
``` ```bash
v self v self
``` ```
@ -175,7 +177,7 @@ v run tetris/tetris.v
If you plan to use the http package, you also need to install OpenSSL on non-Windows systems. If you plan to use the http package, you also need to install OpenSSL on non-Windows systems.
``` ```bash
macOS: macOS:
brew install openssl brew install openssl
@ -189,7 +191,6 @@ Fedora:
sudo dnf install openssl-devel sudo dnf install openssl-devel
``` ```
## V UI ## V UI
<a href="https://github.com/vlang/ui"> <a href="https://github.com/vlang/ui">
@ -228,7 +229,6 @@ https://github.com/vlang/gitly
<img src="https://user-images.githubusercontent.com/687996/85933714-b195fe80-b8da-11ea-9ddd-09cadc2103e4.png"> <img src="https://user-images.githubusercontent.com/687996/85933714-b195fe80-b8da-11ea-9ddd-09cadc2103e4.png">
## Troubleshooting ## Troubleshooting
Please see the [Troubleshooting](https://github.com/vlang/v/wiki/Troubleshooting) section on our [wiki page](https://github.com/vlang/v/wiki) Please see the [Troubleshooting](https://github.com/vlang/v/wiki/Troubleshooting) section on our [wiki page](https://github.com/vlang/v/wiki)