diff --git a/docz/docs/09-miscellany/05-contributing.md b/docz/docs/09-miscellany/05-contributing.md index 049fdc8..4c0f08c 100644 --- a/docz/docs/09-miscellany/05-contributing.md +++ b/docz/docs/09-miscellany/05-contributing.md @@ -42,11 +42,11 @@ These instructions were tested on the following platforms: | Platform | Architecture | Test Date | |:------------------------------|:-------------|:-----------| | Linux (Steam Deck Holo x64) | `linux-x64` | 2024-04-01 | -| Linux (Ubuntu 18 AArch64) | `linux-arm` | 2023-12-01 | +| Linux (Arch Linux AArch64) | `linux-arm` | 2024-05-10 | | MacOS 14.4 (x64) | `darwin-x64` | 2024-04-04 | | MacOS 14.1.2 (ARM64) | `darwin-arm` | 2023-12-01 | | Windows 10 (x64) + WSL Ubuntu | `win10-x64` | 2024-04-04 | -| Windows 11 (x64) + WSL Ubuntu | `win11-x64` | 2023-10-14 | +| Windows 11 (x64) + WSL Ubuntu | `win11-x64` | 2024-05-10 | | Windows 11 (ARM) + WSL Ubuntu | `win11-arm` | 2023-09-18 | With some additional dependencies, the unminified scripts are reproducible and @@ -79,18 +79,20 @@ In "Turn Windows features on or off", the following features must be enabled: The following command installs Ubuntu within WSL: ```powershell +wsl --update wsl --install Ubuntu ``` In some versions of `wsl`, the `-d` flag must be specified: ```powershell +wsl --update wsl --install -d Ubuntu ``` -:::caution pass +:::info pass -In the last Windows 11 test, there was a `WSL_E_DEFAULT_DISTRO_NOT_FOUND` error. +In some tests, the install failed with a `WSL_E_DEFAULT_DISTRO_NOT_FOUND` error. The resolution is to switch to WSL1, install, and switch back to WSL2: @@ -241,12 +243,19 @@ open node-v12.22.12.pkg -A) Install `curl`, `git`, and `build-essential` using the system package -manager. On Debian and Ubuntu systems, `apt-get` installs packages: +A) Install `curl`, `git`, and build tools using the system package manager. -```bash +On Debian and Ubuntu systems, `build-essential`, `curl` and `git` are required: + +```bash title="Debian and Ubuntu" sudo apt update -sudo apt-get install curl git build-essential +sudo apt-get install build-essential curl git +``` + +On Arch Linux, `base-devel`, `curl` and `git` are required: + +```bash title="Arch Linux" +sudo pacman -Syu base-devel curl git ``` Other Linux distributions may use other package managers. @@ -288,7 +297,7 @@ sudo pacman-key --refresh-keys 4) Install dependencies: ```bash -sudo pacman -S base-devel +sudo pacman -S base-devel git curl ``` :::note pass @@ -300,7 +309,7 @@ This issue was resolved by manually installing `glibc` and `linux-api-headers`: sudo pacman -S glibc linux-api-headers ``` -This is *not required* for building or testing the library. +These packages are *not required* for building or testing the library. ::: @@ -334,20 +343,18 @@ nvm use 16 ::: -C) Run `unzip`. If the program is missing, install manually. Using `apt-get`: +C) Run `unzip`. If the program is missing, install manually: ```bash sudo apt-get install -y unzip ``` -D) Run `make`. If the program is missing, install manually. It is strongly -recommended to install `build-essential` on Debian and Ubuntu: +D) Run `make`. If the program is missing, install manually: ```bash sudo apt-get install -y make ``` -