Skip to content

Commit

Permalink
chore(main): add documentation for Windows (WSL2) installation (#1045)
Browse files Browse the repository at this point in the history
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 <ping-lin.chang@instill.tech>
  • Loading branch information
namwoam and pinglin authored Jul 23, 2024
1 parent ffc2e0d commit 5b43da4
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).

Expand Down

0 comments on commit 5b43da4

Please sign in to comment.