summaryrefslogtreecommitdiffstats
path: root/docs/zh-cn
diff options
context:
space:
mode:
authorNick Brassel <nick@tzarc.org>2023-03-03 14:16:18 +1100
committerGitHub <noreply@github.com>2023-03-03 14:16:18 +1100
commit4cf8f69a4b7df673f4948f4edf920fa30a2bce22 (patch)
tree3e4bd89ccda0a0b3604e35fc66685f8ea5fc6df1 /docs/zh-cn
parentbe781927c15b5452546a9132d30c3baaf101cef5 (diff)
Remove Vagrant due to bit-rot. (#20000)
Diffstat (limited to 'docs/zh-cn')
-rw-r--r--docs/zh-cn/_summary.md3
-rw-r--r--docs/zh-cn/getting_started_vagrant.md61
2 files changed, 1 insertions, 63 deletions
diff --git a/docs/zh-cn/_summary.md b/docs/zh-cn/_summary.md
index 3baee6dc2e..b8c26ac275 100644
--- a/docs/zh-cn/_summary.md
+++ b/docs/zh-cn/_summary.md
@@ -42,7 +42,6 @@
* [键映射总览](zh-cn/keymap.md)
* 开发环境
* [Docker指南](zh-cn/getting_started_docker.md)
- * [Vagrant指南](zh-cn/getting_started_vagrant.md)
* 刷写(Flashing)
* [刷写](zh-cn/flashing.md)
* [刷写ATmega32A (ps2avrgb)](zh-cn/flashing_bootloadhid.md)
@@ -188,5 +187,5 @@
* [Midi辅助功能](zh-cn/internals/midi_util.md)
* [发送函数](zh-cn/internals/send_functions.md)
* [Sysex工具](zh-cn/internals/sysex_tools.md)
-
+
<!--fromen:20211014-12:00(GMT+8) commit 04cf161aa01fd433b5dae69d9fd31569ed5dca59-->
diff --git a/docs/zh-cn/getting_started_vagrant.md b/docs/zh-cn/getting_started_vagrant.md
deleted file mode 100644
index 5e5de44552..0000000000
--- a/docs/zh-cn/getting_started_vagrant.md
+++ /dev/null
@@ -1,61 +0,0 @@
-# Vagrant快速上手指引
-
-<!---
- original document: 0.15.12:docs/getting_started_vagrant.md
- git diff 0.15.12 HEAD -- docs/getting_started_vagrant.md | cat
--->
-
-本工程包含一份 `Vagrantfile`,可以方便地在不更改你系统环境情况下完成新固件文件的构建工作。这同时也保证了在你拉取该工程代码后的编译环境与也使用Vagrantfile的其它人的一致。当你需要其他人协助你排查遇到的问题时会方便很多。
-
-## 需求
-
-本工程中的 `Vagrantfile` 需要安装[Vagrant](https://www.vagrantup.com/)以及可用的虚拟机服务:
-
-* [VirtualBox](https://www.virtualbox.org/) (5.0.12及以后版本)
- * 卖点是'最适用于Vagrant的平台'
-* [VMware Workstation](https://www.vmware.com/products/workstation) 及 [Vagrant VMware插件](https://www.vagrantup.com/vmware)
- * (付费购买的)VMware插件需要在经过正版授权的VMware Workstation/Fusion上运行
-* [Docker](https://www.docker.com/)
-
-安装了Vagrant之后,在安装合适的虚拟机服务后可能需要重启机器。拉取本工程后在工程目录下执行 'vagrant up' 将启动一个包含了所有本工程所需工具的构建环境(虚拟机或是容器)。最后会有一个vagrant启动提示告知你一切正常就绪,否则你也可以参考一下下面的构建文档。
-
-## 刷写固件
-
-比较“简单”的方案是在你的宿主系统上借助以下工具刷写固件:
-
-* [QMK工具箱](https://github.com/qmk/qmk_toolbox) (推荐)
-* [Teensy Loader](https://www.pjrc.com/teensy/loader.html)
-
-如果你希望通过命令行进行编程工作,可以在Vagrantfile中取消掉['modifyvm']的注释以允许USB直通到Linux环境,既可以使用dfu-util/dfu-programmer之类的命令行工具进行编程工作,或是安装Teensy的命令行版本。
-
-## Vagrantfile概览
-开发环境被配置为运行QMK Docker镜像 `qmkfm/qmk_cli`,不仅让各系统下的功能预期一致,也是我们CI环境的镜像。
-
-## FAQ
-
-### 为什么我的VirtualBox环境会有问题?
-VirtualBox 5的某些版本与工程中Vagrantfile中指定的VirtualBox扩展存在兼容问题。如果你遇到了/vagrant挂载不成功的问题,请升级VirtualBox至5.0.12或更高版本。**或者,可以尝试执行如下命令:**
-
-```console
-vagrant plugin install vagrant-vbguest
-```
-
-### 如何移除一个现有环境?
-不再需要这个环境了是吗?在本工程目录下的任何位置,执行:
-
-```console
-vagrant destroy
-```
-
-### 如果我是想直接用Docker呢?
-想在不使用虚拟机技术的情况下也能使用Vagrant工作流?Vagrangfile已配置为允许绕过运行虚拟机,直接运行容器。通过如下方式执行命令可以强制使用Docker来启动环境:
-```console
-vagrant up --provider=docker
-```
-
-### 如何访问虚拟机环境而非Docker容器?
-通过如下方法跳过 `vagrant` 的用户初始化过程以在QMK构建镜像中直接执行:
-
-```console
-vagrant ssh -c 'sudo -i'
-```