Documentation (#1630)

README.md

@@ -39,6 +39,7 @@ MsQuic has several features that differentiates it from other QUIC implementatio
   * For release details, see the [Release docs](./docs/Release.md).
   * For performance data, see the [Performance dashboard](https://aka.ms/msquicperformance).
   * For building the MsQuic library, see the [Build docs](./docs/BUILD.md).
+  * For testing the MsQuic library, after the build step see the [Run Tests](./docs/TEST.md).
   * For using the MsQuic API, see the [API docs](./docs/API.md) or the [Sample](./src/tools/sample/sample.cpp).
   * For deploying with MsQuic, see the [Deployment docs](./docs/Deployment.md).
   * For diagnosing MsQuic, see the [Diagnostics docs](./docs/Diagnostics.md) and the [Trouble Shooting Guide](./docs/TSG.md).

docs/BUILD.md

@@ -115,6 +115,12 @@ To build the code, you just need to run `build.ps1` in the `scripts` folder:
 ./scripts/build.ps1
 ```
 
+Note that `schannel` TLS provider requires the latest Windows versions (Windows Server 2022 or Insider Preview) to function. If you don't have `schannel` use `openssl` to build and test.
+
+```
+./scripts/build.ps1 -Tls openssl
+```
+
 The script has a lot of additional configuration options, but the default should be fine for most.
 
 ### Config options

docs/TEST.md

@@ -16,6 +16,14 @@ So, for a reliable run, that also includes logs for failed tests, run:
 ./scripts/test.ps1 -LogProfile Full.Light
 ```
 
+Note that you will need to use Powershell 7 in administrator mode to get the logs.
+
+Also, note that `schannel` TLS provider requires the latest Windows versions (Windows Server 2022 or Insider Preview) to function. If you don't have `schannel` use `openssl` to build and test.
+
+```
+./scripts/test.ps1 -Tls openssl -LogProfile Full.Light
+```
+
 If there are any failed tests, this will generate a directory for each failed test that incldues the console output from running the test and any logs collected.
 
 **Example Output**