From 5b43da416300925f5fad974da87830ffad1eace7 Mon Sep 17 00:00:00 2001 From: "andre.liang" <54308739+namwoam@users.noreply.github.com> Date: Tue, 23 Jul 2024 01:45:00 +0100 Subject: [PATCH] chore(main): add documentation for Windows (WSL2) installation (#1045) Because - We want to add support `instill-core` on Windows. This commit - Provides documentation for installing `instill-core` on Windows through WSL2 Co-authored-by: Ping-Lin Chang --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3c1cbc84..a51b1dd8 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,15 @@ Not quite into self-hosting? We've got you covered with **☁️ [Instill Cloud] ## Prerequisites -- **macOS or Linux** - **🔮 Instill Core** works on macOS or Linux, but does not support Windows yet. +- **macOS or Linux** - **🔮 Instill Core** works on macOS or Linux + +- **Windows** - **🔮 Instill Core** works on Windows through Windows Linux Subsystem (WSL2) + + - Install the lastest version of `yq` from the GitHub [Repository](https://github.com/mikefarah/yq), as the package `yq` is not installed on Ubuntu WSL2 by default + + - Install the latest version of Docker Desktop on Windows and enable the WSL2 integration following the [tutorial](https://docs.docker.com/desktop/wsl) by Docker + + - (optional) Install `cuda-toolkit` on WSL2 following the [tutorial](https://docs.nvidia.com/cuda/wsl-user-guide/index.html#getting-started-with-cuda-on-wsl-2) by NVIDIA - **Docker and Docker Compose** - **🔮 Instill Core** requires Docker Engine `v25` or later and Docker Compose `v2` or later to run all services locally. Please install the latest stable [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/).