[embedder] Add setup instructions for Windows.
I was able to run the sample app on WSL for Windows
using these instructions.
Change-Id: Ifa7818a88f22abe2f2d62359c101729f349dd567
diff --git a/README.md b/README.md
index d8f7d49..af31325 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,10 @@
## Requirements
+**If you're using WSL (Windows Subsystem for Linux), see
+[SETUP_WINDOWS.md](https://fuchsia.googlesource.com/flutter-embedder/+/refs/heads/main/SETUP_WINDOWS.md)
+first.**
+
1. Set `$FUCHSIA_EMBEDDER_DIR` to your flutter-embedder.git checkout location,
for example `~/flutter-embedder`.
@@ -76,11 +80,14 @@
1. You will
[need to get the Flutter Engine source code](https://github.com/flutter/flutter/wiki/Setting-up-the-Engine-development-environment).
**Note that this is not just cloning https://github.com/flutter/engine.**
+
2. Set `$ENGINE_DIR` to the `src` folder of your Flutter Engine checkout location,
for example `~/engine/src`.
+
3. `$DEPOT_TOOLS` should be set to your
[`depot_tools`](https://commondatastorage.googleapis.com/chrome-infra-docs/flat/depot_tools/docs/html/depot_tools_tutorial.html#_setting_up)
location, for example `~/depot_tools`.
+
4. For `sync_engine_artifacts_to_revision.sh`, you will need to `git stash` or `git commit` any local
changes to the Flutter Engine. This is not necesssary for `build_and_copy_engine_artifacts.sh`.
diff --git a/SETUP_WINDOWS.md b/SETUP_WINDOWS.md
new file mode 100644
index 0000000..46f5b5c
--- /dev/null
+++ b/SETUP_WINDOWS.md
@@ -0,0 +1,35 @@
+# Additional setup for Windows (experimental)
+
+These are experimental instructions build and run
+the Flutter embedder on [WSL2](https://docs.microsoft.com/en-us/windows/wsl/install)
+in Windows. They are experimental instructions because we don't regularly test this workflow.
+If you encounter an issue, please file a bug at https://bugs.fuchsia.dev.
+
+These instructions assume you are using WSL's built-in version of Ubuntu.
+
+1. Follow https://boxofcables.dev/kvm-optimized-custom-kernel-wsl2-2022/ to make KVM work
+ in WSL, which is required for the emulator to work. This requires installing Open SUSE
+ but the rest of these instructions assume you are using Ubuntu after you've finished
+ building and installing your custom kernel for WSL.
+
+2. Install gcc:
+
+ ```sh
+ sudo apt install gcc
+ ```
+
+3. Install qemu for KVM and give yourself access to KVM:
+
+ ```sh
+ sudo apt install qemu-kvm
+ sudo chown $USER -R /dev/kvm
+ ```
+
+4. Setup [TUN](https://en.wikipedia.org/wiki/TUN/TAP) for qemu:
+
+ ```sh
+ sudo tunctl -t qemu -u $USER
+ ```
+
+You should now be able to follow the rest of the setup instructions
+in the main [README.md](https://fuchsia.googlesource.com/flutter-embedder).
\ No newline at end of file
