Skip to content

Commit

Permalink
Clarify Windows instructions [no-ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
bdevans committed Oct 11, 2023
1 parent cacd954 commit fd437d9
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Install [Docker](https://www.docker.com/products/docker-desktop/) and configure
| ------- | ----------------------------------------------------------------- |
| Linux | Install [Docker for Linux](https://docs.docker.com/desktop/install/linux-install/). All available RAM and processing cores are shared by default. |
| macOS | 1. Install [Docker for mac](https://docs.docker.com/desktop/install/mac-install/). <br>2. [Configure the preferences](https://docs.docker.com/desktop/settings/mac/) to increase the available RAM and share any desired areas of the hard disk. |
| Windows | 0. On Windows 10 or later, install WSL2 (if not already installed) then install the latest Ubuntu "App" from the Microsoft store. This can be accomplished by [opening PowerShell as an administrator](https://ubuntu.com/tutorials/install-ubuntu-on-wsl2-on-windows-10#2-install-wsl) and running: `wsl --install -d ubuntu`. <br>1. Install [Docker for Windows](https://docs.docker.com/desktop/install/windows-install/) and [enable WSL extension integration in Docker Settings](https://learn.microsoft.com/en-us/windows/wsl/tutorials/wsl-containers) (in particular for the Ubuntu App). We recommend [PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.3) as a more powerful alternative to the Command Prompt. <br>2. [Configure the preferences](https://docs.docker.com/desktop/settings/windows/) to [increase RAM](https://gist.github.com/jctosta/a8942ff4f8fbf01e339a0579172cb9fe) and select which local drives should be available to containers (e.g. the `C:` drive). <br>3. Open the Ubuntu App and clone the Chaste repository within this environment. VSCode should be opened from here by typing `code .` in the Ubuntu shell. Keeping the files within the Ubuntu filesystem in this way will greatly improve File I/O performance. <br>4. [Optional] [Install git on the host](https://www.atlassian.com/git/tutorials/install-git#windows) for tracking changes in your projects and to enable you to build the Docker image directly from GitHub if required. Installing [`posh-git`](https://git-scm.com/book/uz/v2/Appendix-A%3A-Git-in-Other-Environments-Git-in-Powershell) enables tab completion for git commands. |
| Windows | 0. On Windows 10 or later, install WSL2 (if not already installed) then install the latest Ubuntu "App" from the Microsoft store. This can be accomplished by [opening PowerShell as an administrator](https://ubuntu.com/tutorials/install-ubuntu-on-wsl2-on-windows-10#2-install-wsl) and running: `wsl --install -d ubuntu`. <br>1. Install [Docker for Windows](https://docs.docker.com/desktop/install/windows-install/). <br>2. [Configure the preferences](https://docs.docker.com/desktop/settings/windows/) to [enable WSL extension integration in Docker Settings](https://learn.microsoft.com/en-us/windows/wsl/tutorials/wsl-containers) (in particular for the Ubuntu App) then [increase the available RAM](https://gist.github.com/jctosta/a8942ff4f8fbf01e339a0579172cb9fe) and select which local drives should be available to containers (e.g. the `C:` drive). <br>3. Launch the Ubuntu App which will provide a shell to type commands in. You can then either run a container [using a pre-built image](#recommended-using-a-pre-built-image) or [use the VS Code devcontainer](#alternative-use-the-vs-code-devcontainer) by cloning the Chaste repository within the Ubuntu environment, then opening VS Code by typing `code .` and finally clicking "Reopen in Container" in the VS Code popup window. Keeping the files within the Ubuntu filesystem in this way will greatly improve File I/O performance. <br>4. [Optional] [Install git on the host](https://www.atlassian.com/git/tutorials/install-git#windows) for tracking changes in your projects and to enable you to build the Docker image directly from GitHub if required. Installing [`posh-git`](https://git-scm.com/book/uz/v2/Appendix-A%3A-Git-in-Other-Environments-Git-in-Powershell) enables tab completion for git commands. |

> :warning: Allocate at least 4GB of RAM to Docker or compilation will fail with strange errors!
Expand Down

0 comments on commit fd437d9

Please sign in to comment.