From 12d66208b838d825bc10f2afdad0fc83e9487cfb Mon Sep 17 00:00:00 2001 From: tarunama Date: Tue, 11 Aug 2020 08:07:17 +0900 Subject: [PATCH] readme: minor clean up (#6055) --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 89f68dd767..0da5cd5c31 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,8 @@ - Built-in graphics library - Easy cross compilation - 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 ## 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 language, very similar to the way it is right now. - - ## Installing V from source ### 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: -``` +```bash v up ``` @@ -108,9 +107,11 @@ 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: + ```bat .\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. @@ -132,7 +133,8 @@ docker run --rm -it vlang:latest v ``` -### Docker with Alpine/musl: +### Docker with Alpine/musl + ```bash git clone https://github.com/vlang/v cd v @@ -140,14 +142,14 @@ docker build -t vlang --file=Dockerfile.alpine . docker run --rm -it vlang:latest /usr/local/v/v ``` - + ### Testing and running the examples Make sure V can compile itself: -``` +```bash 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. -``` +```bash macOS: brew install openssl @@ -189,7 +191,6 @@ Fedora: sudo dnf install openssl-devel ``` - ## V UI @@ -228,7 +229,6 @@ https://github.com/vlang/gitly - ## Troubleshooting Please see the [Troubleshooting](https://github.com/vlang/v/wiki/Troubleshooting) section on our [wiki page](https://github.com/vlang/v/wiki)