From 3ec63cf31f7239b446e40fdaec1991675af0902a Mon Sep 17 00:00:00 2001 From: yougotwill Date: Thu, 6 Feb 2025 11:49:21 +1100 Subject: [PATCH] fix: match windows instruction style for macos in contributing --- CONTRIBUTING.md | 45 +++++++++++++++++++++++++++++++++------------ 1 file changed, 33 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1fb197478..f0a8b1ca9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,26 +48,47 @@ pip install setuptools - Install the [Xcode Command-Line Tools](http://osxdaily.com/2014/02/12/install-command-line-tools-mac-os-x/). - - **Optional:** Install [Homebrew](https://brew.sh/). + **Optional:** Install [Homebrew](https://brew.sh/). -- Install [Git](https://git-scm.com). +- Install [Git](https://git-scm.com/download/mac). - - We recommend using Homebrew to install Git. Run `brew install git`. + We recommend using Homebrew to install Git. + + ```sh + brew install git + ``` - Install [Git-LFS](https://git-lfs.com/) - - We recommend using Homebrew to install Git-LFS. Run `brew install git-lfs`. + We recommend using Homebrew to install Git-LFS. + + ```sh + brew install git-lfs + ``` + +- Install [Node.JS](https://nodejs.org/en/download/) + + We recommend using `nvm` or `asdf`. + + You can get the current `` from the [`.nvmrc`](.nvmrc). + +- Install [Python](https://www.python.org/downloads/) + + We recommend using `asdf`. -- Install [Node.JS](https://nodejs.org) + You can get the current `` from the [`.tool-versions`](.tool-versions). - - We recommend using `nvm` or `asdf`. - - You can get the current `` from the [`.nvmrc`](.nvmrc). - - Install [Yarn Classic](https://classic.yarnpkg.com/en/docs/install/#mac-stable) by running `npm install --global yarn`. +- Install [setuptools](https://pypi.org/project/setuptools/). -- Install [Python](https://www.python.org) - - We recommend using `asdf`. - - You can get the current `` from the [`.tool-versions`](.tool-versions). - - Install [setuptools](https://pypi.org/project/setuptools/) by running `pip install setuptools`. + ```sh + pip install setuptools + ``` + +- Install [Yarn Classic](https://classic.yarnpkg.com/en/docs/install/#mac-stable) + + ```sh + npm install --global yarn + ``` ### Windows