Skip to content

Commit 9598460

Browse files
authored
Merge pull request #236 from devc007/WindowsSupport
docs: Update scripts in the documetation to support windows (fixes #165)
2 parents af9ff9d + b4e9d9a commit 9598460

File tree

2 files changed

+46
-2
lines changed

2 files changed

+46
-2
lines changed

README-zh.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,35 @@ flux-kcl-controller 是一个组件,用于集成 [KCL](https://github.com/kcl-
1717

1818
# 快速开始
1919

20-
## 前提条件
20+
# 先决条件
2121

22-
- k3d: 用于创建测试用的 k8s 集群,如果你已经有了 k8s 集群,可以忽略这一步。
22+
## Linux/Mac 用户:
23+
- k3d:用于创建 k8s 集群进行测试,如果您已经有 k8s 集群,可以跳过此步骤。
2324
- Kustomize
2425
- Kubectl
2526

27+
## Windows 用户:
28+
**安装 WSL (Windows 子系统 Linux):**
29+
1. 以管理员身份打开 PowerShell 并运行:
30+
```powershell
31+
wsl --install
32+
```
33+
2. 重启您的计算机。
34+
3. 打开 WSL 终端并安装所需工具:
35+
```bash
36+
sudo apt update
37+
sudo apt install make kubectl git
38+
39+
# 安装 k3d
40+
curl -s https://raw.githubusercontent.com/k3d-io/k3d/main/install.sh | bash
41+
42+
# 安装 kustomize
43+
curl -s "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh" | bash
44+
sudo mv kustomize /usr/local/bin/
45+
```
46+
47+
### 注意:所有后续命令在所有平台上都是相同的
48+
2649
## 创建测试用的 k8s 集群
2750

2851
通过如下命令创建集群:

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,31 @@ The `flux-kcl-controller` is a component developed for the integration of [KCL](
2020

2121
## Prerequisites
2222

23+
### For Linux/Mac Users:
2324
- k3d: used to create a k8s cluster for testing, if you already have a k8s cluster, you can skip ignore this.
2425
- Kustomize
2526
- Kubectl
2627

28+
### For Windows Users:
29+
**Install WSL (Windows Subsystem for Linux):**
30+
1. Open PowerShell as Administrator and run:
31+
```powershell
32+
wsl --install
33+
2. Restart your computer.
34+
3. Open WSL terminal and install required tools:
35+
```
36+
sudo apt update
37+
sudo apt install make kubectl git
38+
39+
# Install k3d
40+
curl -s https://raw.githubusercontent.com/k3d-io/k3d/main/install.sh | bash
41+
42+
# Install kustomize
43+
curl -s "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh" | bash
44+
sudo mv kustomize /usr/local/bin/
45+
```
46+
### Note: All subsequent commands are the same for all platforms
47+
2748
## Create a test k8s cluster
2849
2950
Create a cluster using the following command:

0 commit comments

Comments
 (0)