From b3cae3614f3a8fa26dcf583907fe1dd286ce0eda Mon Sep 17 00:00:00 2001
From: Ben Jackson <puremourning@users.noreply.github.com>
Date: Fri, 9 Oct 2020 11:18:39 +0100
Subject: [PATCH] Add WSL instructions.

---
 test/README.md | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/test/README.md b/test/README.md
index e109b4fc..3b590a23 100644
--- a/test/README.md
+++ b/test/README.md
@@ -31,7 +31,25 @@ in which you can run the tests.
 * Ensure ycmd is compiled ***with python3*** and clangd is enabled
   `python3 install.py --ts-completer --clangd-completer --java-completer`
 * Install the test python deps (`pip install -r python/test_requirements.txt`)
-* Run `./run_vim_tests`
+* Run `./test/run_vim_tests`
+
+## Runniing the tests in Windows (WSL)
+
+NOTE: This environment isn't officially supported, and the preferred mechanism to run the tests is to use docker.
+
+* Install Ubuntu 20.04 WSL from Windows Store and launch it
+* `sudo apt-get update && sudo apt-get dist-upgrade`
+* `sudo apt-get install build-essential default-jdk vim-nox cmake python3-dev nodejs python3-pip npm`
+* clone the plugin, and build ycmd, e.g.
+
+```
+git clone --recursive https://github.com/ycm-core/YouCompleteMe
+cd YouCompleteMe
+python3 install.py --ts-completer --clangd-completer --java-completer
+```
+
+* Install the test python deps: `pip3 install --user -r python/test_requirements.txt`
+* Run `./test/run_vim_tests`
 
 # Overview
 
-- 
2.29.1

