docs: add section in README for compilation on FreeBSD (#24706)

lcheylus · web-flow · commit 99c39ab8827b · 2025-06-12T22:31:18.000+03:00
diff --git a/README.md b/README.md
@@ -111,60 +111,8 @@ v up
 > 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
-
-The [Tiny C Compiler (tcc)](https://repo.or.cz/w/tinycc.git) is downloaded for you by `make` if
-there is a compatible version for your system, and installed under the V `thirdparty` directory.
-
-This compiler is very fast, but does almost no optimizations. It is best for development builds.
-
-For production builds (using the `-prod` option to V), it's recommended to use clang, gcc, or
-Microsoft Visual C++. If you are doing development, you most likely already have one of those
-installed.
-
-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)
-
-- [Installing a C compiler on Windows](https://github.com/vlang/v/wiki/Installing-a-C-compiler-on-Windows)
-
-### Symlinking
-
-> [!NOTE]
-> 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 every time.
-> 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:
-
-```bash
-sudo ./v symlink
-```
-
-On Windows, start a new shell with administrative privileges, for example by pressing the
-<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, then
-type:
-
-```bat
-v symlink
-```
-
-(or `./v symlink` in PowerShell)
-
-That will make V available everywhere, by adding it to your PATH. Please restart your
-shell/editor after that, so that it can pick up the new PATH variable.
-
-> [!NOTE]
-> There is no need to run `v symlink` more than once - v will still 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.
-
 ### Void Linux
 
-<details><summary>Expand Void Linux instructions</summary>
-
 ```bash
 # xbps-install -Su base-devel
 # xbps-install libatomic-devel
@@ -173,11 +121,8 @@ $ cd v
 $ make
 ```
 
-</details>
-
 ### Docker
 
-
 ```bash
 git clone --depth=1 https://github.com/vlang/v
 cd v
@@ -211,6 +156,18 @@ You should see something like this:
 -rwxr-xr-x 1 root root 335308 May 27 17:07 examples/http_server
 ```
 
+### FreeBSD
+
+On FreeBSD, V needs `boehm-gc-threaded` package preinstalled. After installing it, you can use the
+same script, like on Linux/macos:
+
+```bash
+pkg install boehm-gc-threaded
+git clone --depth=1 https://github.com/vlang/v
+cd v
+make
+```
+
 ### Termux/Android
 
 On Termux, V needs some packages preinstalled - a working C compiler, also `libexecinfo`,
@@ -224,6 +181,56 @@ cd v
 make
 ```
 
+### C compiler
+
+The [Tiny C Compiler (tcc)](https://repo.or.cz/w/tinycc.git) is downloaded for you by `make` if
+there is a compatible version for your system, and installed under the V `thirdparty` directory.
+
+This compiler is very fast, but does almost no optimizations. It is best for development builds.
+
+For production builds (using the `-prod` option to V), it's recommended to use clang, gcc, or
+Microsoft Visual C++. If you are doing development, you most likely already have one of those
+installed.
+
+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)
+
+- [Installing a C compiler on Windows](https://github.com/vlang/v/wiki/Installing-a-C-compiler-on-Windows)
+
+### Symlinking
+
+> [!NOTE]
+> 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 every time.
+> 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:
+
+```bash
+sudo ./v symlink
+```
+
+On Windows, start a new shell with administrative privileges, for example by pressing the
+<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, then
+type:
+
+```bat
+v symlink
+```
+
+(or `./v symlink` in PowerShell)
+
+That will make V available everywhere, by adding it to your PATH. Please restart your
+shell/editor after that, so that it can pick up the new PATH variable.
+
+> [!NOTE]
+> There is no need to run `v symlink` more than once - v will still 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.
+
 ## Editor/IDE Plugins
 
 - [Atom](https://github.com/vlang/awesome-v#atom)
