diff --git a/README.md b/README.md index dd1a21ac6b..09945499d1 100644 --- a/README.md +++ b/README.md @@ -26,10 +26,10 @@ optimization)* ([demo video](https://www.youtube.com/watch?v=pvP6wmcl_Sc)) - 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) -- 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)) - 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) - Built-in graphics library - Easy cross-compilation @@ -95,9 +95,9 @@ v up > 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 > [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. ### 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 -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) tutorial and Gitly, a light and fast alternative to GitHub/GitLab: @@ -328,18 +328,18 @@ https://github.com/vlang/vinix ## Acknowledgement -V thanks Fabrice Bellard for his original work on the -[TCC - Tiny C Compiler](https://bellard.org/tcc/). -Note the TCC website is old; the current TCC repository can be found -[here](https://repo.or.cz/w/tinycc.git). -V utilizes pre-built TCC binaries located at +V thanks Fabrice Bellard for his original work on the +[TCC - Tiny C Compiler](https://bellard.org/tcc/). +Note the TCC website is old; the current TCC repository can be found +[here](https://repo.or.cz/w/tinycc.git). +V utilizes pre-built TCC binaries located at [https://github.com/vlang/tccbin/](https://github.com/vlang/tccbin/). ## Troubleshooting -Please see the -[Troubleshooting](https://github.com/vlang/v/wiki/Troubleshooting) -section on our +Please see the +[Troubleshooting](https://github.com/vlang/v/wiki/Troubleshooting) +section on our [wiki page](https://github.com/vlang/v/wiki) [WorkflowBadge]: https://github.com/vlang/v/workflows/CI/badge.svg diff --git a/doc/docs.md b/doc/docs.md index 4c103ced6c..7c272a6883 100644 --- a/doc/docs.md +++ b/doc/docs.md @@ -2717,8 +2717,6 @@ println(c()) // 3 ``` 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 mut i := 0 @@ -6276,7 +6274,7 @@ Module { ``` > **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*. > Any .v file beside or below the folder where the v.mod file is, > can use `#flag @VMODROOT/abc` to refer to this folder.