diff options
| author | Nirbheek Chauhan <nirbheek@centricular.com> | 2023-07-24 20:36:40 +0530 |
|---|---|---|
| committer | GStreamer Marge Bot <gitlab-merge-bot@gstreamer-foundation.org> | 2024-01-29 18:52:19 +0000 |
| commit | 9db7fc719382ab7d9c1607695ba87ceef4934ba4 (patch) | |
| tree | 6f4ef6ae7692ea40613e0c2a378247b8dbc3fcca | |
| parent | 732fe02685b72601630207ace977fe4016d2c090 (diff) | |
README: Various windows-specific doc fixes
Part-of: <https://gitlab.freedesktop.org/gstreamer/cerbero/-/merge_requests/1238>
| -rw-r--r-- | README.md | 32 |
1 files changed, 17 insertions, 15 deletions
@@ -37,9 +37,11 @@ Cerbero will build all other required packages during [bootstrap](#Bootstrap). ### Windows Setup The initial setup on Windows is automated with the PowerShell script -[bootstrap-windows][tools/bootstrap-windows.ps1]. It installs the following tools: +[bootstrap-windows](tools/bootstrap-windows.ps1). It will auto-detect and +installs the necessary tools with [Chocolatey](https://chocolatey.org/): * Visual Studio 2019 or 2022 Build Tools +* CMake * MSYS2 * Git * Python 3 @@ -313,30 +315,30 @@ Note that Autotools recipes continue to require MinGW. #### Important Windows-specific Notes -You should add the cerbero git directory to the list of excluded folders in your +* MSYS2 comes with different [environments](https://www.msys2.org/docs/environments/). +Cerbero must be run using the UCRT64, since it targets the same CRT as our toolchain. +The UCRT64 shell can be launched with the application : `c:\msys64\ucrt64.exe` + +* You should add the cerbero git directory to the list of excluded folders in your anti-virus, or you will get random build failures when Autotools does file operations such as renames and deletions. It will also slow your build by about 3-4x. -MSYS2 comes with different [environments](https://www.msys2.org/docs/environments/). Cerbero must be run using the UCRT64, since it targets the same CRT as our toolchain. - -The UCRT64 shell can be launched with the application : `c:\msys64\ucrt64.exe`. - -The path to your `$HOME` must not contain spaces. If your Windows username -contains spaces, you can create a new directory in `/home` and execute: - -If you are using Windows 10, it is also highly recommended to enable "Developer +* If you are using Windows 10, it is also highly recommended to enable "Developer Mode" in Windows Settings as shown below.  -```cmd -$ echo 'export HOME=/home/newdir' > ~/.profile -``` +* The path to your `$HOME` must not contain spaces. If your Windows username +contains spaces, you can create a new directory in `/home` and execute: + + ```cmd + $ echo 'export HOME=/home/newdir' > ~/.profile + ``` -Then restart your shell and type `cd` to go to the new home directory. + Then restart your shell and type `cd` to go to the new home directory. -Note that inside the shell, `/` is mapped to `C:\msys64` + Note that inside the shell, `/` is mapped to `C:\msys64` # Customising Cerbero |