Skip to content

Commit

Permalink
docs: add Windows build performance
Browse files Browse the repository at this point in the history
  • Loading branch information
gjrtimmer committed Jan 28, 2025
1 parent 7b92935 commit a9f9f6c
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ facilitate most of this functionality.
- [Start DevContainer](#start-devcontainer)
- [macOS / Darwin](#macos--darwin)
- [macOS / Darwin Build Performance](#macos--darwin-build-performance)
- [Windows](#windows)
- [Build Performance](#build-performance)
- [Scripts](#scripts)
- [Commands](#commands)
- [Building](#building)
Expand Down Expand Up @@ -127,6 +129,19 @@ For the best performance on macOS Docker-Desktop is recommended with the use of
the currently `BETA` feature of `Docker VMM` as Virtual Machine.
The `Apple Virtualization Framework` can cause Docker-Desktop to crash during a build.

## Windows

For building on Windows, both devcontainers can be used either the linux or darwin container.

### Build Performance

When building on Windows with Anti-Virus software present, it is important to understand that
this can severly impact build speed as each file will be scanned during the build process.
Furthermore, the on-access scanner of Anti-Virus software can cause build compiliation corruption.
In order to bypass this, Windows users can use the macOS / darwin devcontainer, this will build
according to the same build process in a volume and the developer can use the `git sync` command
or `./scripts/sync.sh` to sync files between the host and the devcontainer.

## Scripts

The repository provides several scripts to facilitate easy development. All scripts are located in
Expand Down

0 comments on commit a9f9f6c

Please sign in to comment.