Skip to content

Commit

Permalink
Update the README setup steps (#5924)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
Gudahtt authored Mar 8, 2023
1 parent 1532692 commit 65ef08a
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```


Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit 65ef08a

Please sign in to comment.