mirrors/v
1
0
Fork 0
mirror of https://github.com/vlang/v.git synced 2025-09-13 14:32:26 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

readme: minor fixes

Browse source
This commit is contained in:
Alexander Medvednikov 2023-02-28 09:55:57 +01:00
parent b7b6c2368e
commit d5ad96f876
2 changed files with 14 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -26,10 +26,10 @@
optimization)* ([demo video](https://www.youtube.com/watch?v=pvP6wmcl_Sc)) optimization)* ([demo video](https://www.youtube.com/watch?v=pvP6wmcl_Sc))
- Easy to develop: V compiles itself in less than a second - 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) - 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 - Safety: no null, no globals, no undefined behavior (wip), immutability by default
- C to V translation ([Translating DOOM demo video](https://www.youtube.com/watch?v=6oXrz3oRoEg)) - C to V translation ([Translating DOOM demo video](https://www.youtube.com/watch?v=6oXrz3oRoEg))
- Hot code reloading - Hot code reloading
- [Innovative memory management](https://vlang.io/#memory) ([demo video](https://www.youtube.com/watch?v=gmB8ea8uLsM)) - [Flexible memory management](https://vlang.io/#memory) ([demo video](https://www.youtube.com/watch?v=gmB8ea8uLsM))
- [Cross-platform UI library](https://github.com/vlang/ui) - [Cross-platform UI library](https://github.com/vlang/ui)
- Built-in graphics library - Built-in graphics library
- Easy cross-compilation - Easy cross-compilation
@ -95,9 +95,9 @@ v up
> If you run into any trouble, or you have a different operating > 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 > system or Linux distribution that doesn't install or work immediately, please see
> [Installation Issues](https://github.com/vlang/v/discussions/categories/installation-issues) > [Installation Issues](https://github.com/vlang/v/discussions/categories/installation-issues)
> and search for your OS and problem. > 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 > 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. > your OS, or create a new one if a main discussion doesn't yet exist for your OS.
### C compiler ### C compiler
@ -308,7 +308,7 @@ With V's `vab` tool, building V UI and graphical apps for Android can become as
## Developing web applications ## Developing web applications
Check out the Check out the
[Building a simple web blog](https://github.com/vlang/v/blob/master/tutorials/building_a_simple_web_blog_with_vweb/README.md) [Building a simple web blog](https://github.com/vlang/v/blob/master/tutorials/building_a_simple_web_blog_with_vweb/README.md)
tutorial and Gitly, a light and fast alternative to GitHub/GitLab: tutorial and Gitly, a light and fast alternative to GitHub/GitLab:
@ -328,18 +328,18 @@ https://github.com/vlang/vinix
## Acknowledgement ## Acknowledgement
V thanks Fabrice Bellard for his original work on the V thanks Fabrice Bellard for his original work on the
[TCC - Tiny C Compiler](https://bellard.org/tcc/). [TCC - Tiny C Compiler](https://bellard.org/tcc/).
Note the TCC website is old; the current TCC repository can be found Note the TCC website is old; the current TCC repository can be found
[here](https://repo.or.cz/w/tinycc.git). [here](https://repo.or.cz/w/tinycc.git).
V utilizes pre-built TCC binaries located at V utilizes pre-built TCC binaries located at
[https://github.com/vlang/tccbin/](https://github.com/vlang/tccbin/). [https://github.com/vlang/tccbin/](https://github.com/vlang/tccbin/).
## Troubleshooting ## Troubleshooting
Please see the Please see the
[Troubleshooting](https://github.com/vlang/v/wiki/Troubleshooting) [Troubleshooting](https://github.com/vlang/v/wiki/Troubleshooting)
section on our section on our
[wiki page](https://github.com/vlang/v/wiki) [wiki page](https://github.com/vlang/v/wiki)
[WorkflowBadge]: https://github.com/vlang/v/workflows/CI/badge.svg [WorkflowBadge]: https://github.com/vlang/v/workflows/CI/badge.svg

4
doc/docs.md
View file

@ -2717,8 +2717,6 @@ println(c()) // 3
``` ```
If you need the value to be modified outside the function, use a reference. If you need the value to be modified outside the function, use a reference.
**Warning**: _you need to make sure the reference is always valid,
otherwise this can result in undefined behavior._
```v oksyntax ```v oksyntax
mut i := 0 mut i := 0
@ -6276,7 +6274,7 @@ Module {
``` ```
> **Note** > **Note**
> @VMODROOT will be replaced by V with the *nearest parent folder, > @VMODROOT will be replaced by V with the *nearest parent folder,
> where there is a v.mod file*. > where there is a v.mod file*.
> Any .v file beside or below the folder where the v.mod file is, > Any .v file beside or below the folder where the v.mod file is,
> can use `#flag @VMODROOT/abc` to refer to this folder. > can use `#flag @VMODROOT/abc` to refer to this folder.