Skip to content

Commit 2f00545

Browse files
authored
Udpdate CONTRIBUTING.md with additional step (#370)
1 parent 7787e18 commit 2f00545

File tree

1 file changed

+25
-19
lines changed

1 file changed

+25
-19
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,33 +16,39 @@ specific to each workspace.
1616

1717
## Getting started
1818

19-
If you've cloned the repo and want to run the sample app, you will first need
20-
to:
19+
If you've cloned the repo and want to run the sample app, you will first need to:
2120

2221
1. Install the NPM dependencies
23-
2. Install iOS dependencies (cocoapods)
24-
3. Build the Native Module
2522

26-
```sh
27-
# Install NPM dependencies and link local module
28-
yarn
23+
```sh
24+
yarn
25+
```
2926

30-
# Install Cocoapods for iOS
31-
yarn pod-install sample/ios
32-
# Note: Android dependencies are automatically installed by Gradle
27+
2. Install iOS dependencies. (N.b. Android dependencies are automatically installed by Gradle)
3328

34-
# Build the Native Module JS
35-
yarn module build
36-
```
29+
```sh
30+
yarn pod-install sample/ios
31+
```
3732

38-
If all of these steps have succeeded, you can now run the sample app with:
33+
3. Build the Native Module
3934

40-
```sh
41-
yarn sample start
42-
```
35+
```sh
36+
yarn module build
37+
```
38+
39+
4. Start the Metro server
40+
41+
```sh
42+
yarn sample start
43+
```
44+
45+
5. Run the sample application (in a new terminal / tab)
4346

44-
This command will start the Metro server. Follow the steps given by Metro to
45-
open both the iOS and Android simulators/emulators respectively.
47+
```sh
48+
yarn sample ios
49+
# or
50+
yarn sample android
51+
```
4652

4753
## Optional: Speed up builds with ccache
4854

0 commit comments

Comments
 (0)