diff options
| author | Ryan <fauxpark@gmail.com> | 2021-09-14 22:16:24 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-14 13:16:24 +0100 |
| commit | b56282756b5faa410301de8c4ecdcae0e0148652 (patch) | |
| tree | cf68cfe0e4f148d6eab52ae289ce261bea88f6c3 /docs/getting_started_vagrant.md | |
| parent | 0ca4a56a0449d17a497ba610d4cee41c914ff50e (diff) | |
| download | qmk_firmware-b56282756b5faa410301de8c4ecdcae0e0148652.tar.gz qmk_firmware-b56282756b5faa410301de8c4ecdcae0e0148652.zip | |
[Docs] Clean up some code block languages (#14434)
Diffstat (limited to 'docs/getting_started_vagrant.md')
| -rw-r--r-- | docs/getting_started_vagrant.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/getting_started_vagrant.md b/docs/getting_started_vagrant.md index 114f87567..b5b5ce153 100644 --- a/docs/getting_started_vagrant.md +++ b/docs/getting_started_vagrant.md | |||
| @@ -31,26 +31,26 @@ The development environment is configured to run the QMK Docker image, `qmkfm/qm | |||
| 31 | ### Why am I seeing issues under Virtualbox? | 31 | ### Why am I seeing issues under Virtualbox? |
| 32 | Certain versions of Virtualbox 5 appear to have an incompatibility with the Virtualbox extensions installed in the boxes in this Vagrantfile. If you encounter any issues with the /vagrant mount not succeeding, please upgrade your version of Virtualbox to at least 5.0.12. **Alternately, you can try running the following command:** | 32 | Certain versions of Virtualbox 5 appear to have an incompatibility with the Virtualbox extensions installed in the boxes in this Vagrantfile. If you encounter any issues with the /vagrant mount not succeeding, please upgrade your version of Virtualbox to at least 5.0.12. **Alternately, you can try running the following command:** |
| 33 | 33 | ||
| 34 | ```console | 34 | ``` |
| 35 | vagrant plugin install vagrant-vbguest | 35 | vagrant plugin install vagrant-vbguest |
| 36 | ``` | 36 | ``` |
| 37 | 37 | ||
| 38 | ### How do I remove an existing environment? | 38 | ### How do I remove an existing environment? |
| 39 | Finished with your environment? From anywhere inside the folder where you checked out this project, Execute: | 39 | Finished with your environment? From anywhere inside the folder where you checked out this project, Execute: |
| 40 | 40 | ||
| 41 | ```console | 41 | ``` |
| 42 | vagrant destroy | 42 | vagrant destroy |
| 43 | ``` | 43 | ``` |
| 44 | 44 | ||
| 45 | ### What if I want to use Docker directly? | 45 | ### What if I want to use Docker directly? |
| 46 | Want to benefit from the Vagrant workflow without a virtual machine? The Vagrantfile is configured to bypass running a virtual machine, and run the container directly. Execute the following when bringing up the environment to force the use of Docker: | 46 | Want to benefit from the Vagrant workflow without a virtual machine? The Vagrantfile is configured to bypass running a virtual machine, and run the container directly. Execute the following when bringing up the environment to force the use of Docker: |
| 47 | ```console | 47 | ``` |
| 48 | vagrant up --provider=docker | 48 | vagrant up --provider=docker |
| 49 | ``` | 49 | ``` |
| 50 | 50 | ||
| 51 | ### How do I access the virtual machine instead of the Docker container? | 51 | ### How do I access the virtual machine instead of the Docker container? |
| 52 | Execute the following to bypass the `vagrant` user booting directly to the official qmk builder image: | 52 | Execute the following to bypass the `vagrant` user booting directly to the official qmk builder image: |
| 53 | 53 | ||
| 54 | ```console | 54 | ``` |
| 55 | vagrant ssh -c 'sudo -i' | 55 | vagrant ssh -c 'sudo -i' |
| 56 | ``` | 56 | ``` |
