From bd7538cf738661f204361a40691efc450a2077e0 Mon Sep 17 00:00:00 2001 From: SheetJS Date: Mon, 11 Nov 2024 00:51:07 -0500 Subject: [PATCH] darwin-arm contributing guide refresh --- .../02-examples/06-loader.md | 2 +- docz/docs/09-miscellany/05-contributing.md | 54 +++++++++++++++---- 2 files changed, 45 insertions(+), 11 deletions(-) diff --git a/docz/docs/02-getting-started/02-examples/06-loader.md b/docz/docs/02-getting-started/02-examples/06-loader.md index 1d07295..9f60503 100644 --- a/docz/docs/02-getting-started/02-examples/06-loader.md +++ b/docz/docs/02-getting-started/02-examples/06-loader.md @@ -35,7 +35,7 @@ This demo was tested in the following configurations: | Platform | Architecture | Date | |:--------------------------------------------------------------|:-------------|:-----------| -| NVIDIA RTX 4090 (24 GB VRAM) + i9-10910 (128 GB RAM) | `win10-x64` | 2024-08-31 | +| NVIDIA RTX 4090 (24 GB VRAM) + Ryzen Z1 Extreme (24 GB RAM) | `win11-x64` | 2024-11-09 | | NVIDIA RTX 4080 SUPER (16 GB VRAM) + i9-10910 (128 GB RAM) | `win10-x64` | 2024-08-09 | | AMD RX 7900 XTX (24 GB VRAM) + Ryzen Z1 Extreme (16 GB RAM) | `win11-x64` | 2024-09-21 | | AMD RX 6800 XT (16 GB VRAM) + Ryzen Z1 Extreme (16 GB RAM) | `win11-x64` | 2024-10-07 | diff --git a/docz/docs/09-miscellany/05-contributing.md b/docz/docs/09-miscellany/05-contributing.md index b3b3c59..5659dce 100644 --- a/docz/docs/09-miscellany/05-contributing.md +++ b/docz/docs/09-miscellany/05-contributing.md @@ -44,7 +44,7 @@ These instructions were tested on the following platforms: | Linux (Steam Deck Holo x64) | `linux-x64` | 2024-09-20 | | Linux (Arch Linux AArch64) | `linux-arm` | 2024-05-10 | | MacOS 14.4 (x64) | `darwin-x64` | 2024-07-12 | -| MacOS 14.5 (ARM64) | `darwin-arm` | 2024-05-23 | +| MacOS 15.1 (ARM64) | `darwin-arm` | 2024-11-10 | | Windows 10 (x64) + WSL Ubuntu | `win10-x64` | 2024-07-12 | | Windows 11 (x64) + WSL Ubuntu | `win11-x64` | 2024-07-26 | | Windows 11 (ARM) + WSL Ubuntu | `win11-arm` | 2024-05-23 | @@ -173,7 +173,7 @@ If this clone fails with an error message that mentions SSL or secure connection or certificates, build and install a version of Git with proper SSL support: ```bash -# Git does not support OpenSSL out of the box, must do this +: # Git does not support OpenSSL out of the box, must do this curl -LO https://github.com/niko-dunixi/git-openssl-shellscript/raw/main/compile-git-with-openssl.sh chmod +x compile-git-with-openssl.sh ./compile-git-with-openssl.sh @@ -205,7 +205,11 @@ sudo apt-get install -y make -A) Open a terminal window and run `git`. +A) Open a terminal window and run `git`: + +```bash +git --version +``` If Xcode or the command-line tools are not installed, you will be asked to install. Click "Install" and run through the steps. @@ -216,6 +220,25 @@ B) Open a terminal window and install the Homebrew package manager: /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" ``` +Follow the on-screen instructions. + +After the installation finishes, add Homebrew to your `PATH`. The instructions +are displayed in the `Next steps` section: + +```bash +: # zsh +echo >> $HOME/.zprofile +echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> $HOME/.zprofile + +: # bash +echo >> $HOME/.bash_profile +echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> $HOME/.bash_profile + +: # other +echo >> $HOME/.profile +echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> $HOME/.profile +``` + C) Close the window, open a new terminal window, and disable analytics: ```bash @@ -232,10 +255,19 @@ The message should state that analytics are disabled or destroyed. D) Install NodeJS. -:::note pass +Open [the official NodeJS site](https://nodejs.org/en/download/) with a web +browser and select "Prebuilt Installer" from the Categories dropdown. -[The official NodeJS site](https://nodejs.org/en/download/) provides installers -for "LTS" and "Current" releases. The "LTS" version should be installed. +Adjust the next three dropdowns as follows: + +- "I want the": Select the first LTS option ("v22.11.0 (LTS)" when last tested) +- "version of Node.js for": Select "macOS" +- "running": Select "x64" for Intel Macs or "ARM64" for Apple Silicon Macs + +Click the green Download button to download the package. After the download +finishes, open the package and follow the steps to install NodeJS + +:::note pass **Older versions of macOS are not compatible with newer versions of NodeJS.** @@ -463,21 +495,23 @@ This step may take a few minutes as the current test snapshot is large. 3) Run the `esbuild` tool once: ```bash -npx -y esbuild@0.14.14 +npx -y esbuild@0.14.14 --version ``` +The command will print the version number `0.14.14`. + 4) Run a build and verify with a short test: ```bash -# Full Build +: # Full Build cd modules; make clean; make; cd .. make make dist -# Short test +: # Short test make test_misc -# Reset repo +: # Reset repo git checkout -- . ```