From 65ef08a7774eb5d30a374ba1a6636cb697d82da7 Mon Sep 17 00:00:00 2001 From: Mark Stacey Date: Tue, 7 Mar 2023 21:38:50 -0330 Subject: [PATCH] Update the README setup steps (#5924) A few project setup steps in the README were obsolete or missing important details. The following changes have been made: * The `pod install` step was removed from the "Building locally" instructions; this is now a part of `yarn setup` and does not need to be run separately. * Update the CocoaPods install command to specify the version, ensuring that the lockfile does not change upon install. * Remove the note about CocoaPods not being required. * Update the Node.js and Yarn install instructions to be separate, and link the Yarn install instructions. --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ea9a23d0526..56a43ff41ef 100644 --- a/README.md +++ b/README.md @@ -19,17 +19,18 @@ The code is built using React-Native and running code locally requires a Mac or - Install [sentry-cli](https://github.com/getsentry/sentry-cli) tools: `brew install getsentry/tools/sentry-cli` -- Install [Node.js](https://nodejs.org) **version 14 (latest stable) and yarn@1 (latest)** +- Install [Node.js](https://nodejs.org) **version 14** - If you are using [nvm](https://github.com/creationix/nvm#installation) (recommended) running `nvm use` will automatically choose the right node version for you. -- Install yarn +- Install [Yarn v1](https://yarnpkg.com/en/docs/install) + - Install the shared [React Native dependencies](https://reactnative.dev/docs/environment-setup#installing-dependencies) (`React Native CLI`, _not_ `Expo CLI`) - Install [cocoapods](https://guides.cocoapods.org/using/getting-started.html) by running: ```bash -sudo gem install cocoapods +sudo gem install cocoapods -v 1.11.3 ``` @@ -70,7 +71,6 @@ sudo gem install cocoapods - Install the iOS dependencies - [React Native Getting Started - iOS](https://reactnative.dev/docs/environment-setup#installing-dependencies) _(React Native CLI Quickstart -> [your OS] -> iOS)_ - - You do **not** need CocoaPods - Install the correct simulator - **iOS OS Version:** Latest, unless told otherwise - **Device:** iPhone 11 Pro @@ -98,7 +98,6 @@ cd metamask-mobile - Install the app: ``` yarn setup # not the usual install command, this will run a lengthy postinstall flow -cd ios && pod install && cd .. # install pods for iOS ``` - Then, in one terminal, run: