From 47a10f31814b11a1222eaf679b1390a74258293e Mon Sep 17 00:00:00 2001 From: JalonSolov Date: Tue, 1 Nov 2022 01:28:39 -0400 Subject: [PATCH] doc: update ssl section in the main README.md (#16273) --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b678c0f7ef..ff01244403 100644 --- a/README.md +++ b/README.md @@ -198,8 +198,12 @@ NB: In order to build Tetris or 2048 (or anything else using `sokol` or `gg` gr on some Linux systems, you need to install `libxi-dev` and `libxcursor-dev` . ## V net.http, net.websocket, `v install` -If you plan to use the net.http module, or the net.websocket module, you also need to install -OpenSSL on non-Windows systems: +The net.http module, the net.websocket module, and the `v install` command may all use SSL. +V comes with a version of mbedtls, which should work on all systems. If you find a need to +use OpenSSL instead, you will need to make sure that it is installed on your system, then +use the `-d use_openssl` switch when you compile. + +To install OpenSSL on non-Windows systems: ```bash macOS: @@ -215,6 +219,9 @@ Fedora: sudo dnf install openssl-devel ``` +On Windows, OpenSSL is simply hard to get working correctly. The instructions +[here](https://tecadmin.net/install-openssl-on-windows/) may (or may not) help. + ## V sync V's `sync` module and channel implementation uses libatomic. It is most likely already installed on your system, but if not,