Skip to content

Commit

Permalink
docs(example): update readme with build step (#6089)
Browse files Browse the repository at this point in the history
<!-- Thanks for submitting a pull request! We appreciate you spending
the time to work on these changes. Please follow the template so that
the reviewers can easily understand what the code changes affect. -->

## Summary

I had trouble running the Example app after following the README steps.
After building from the root of the monorepo, the iOS app began working
so I updated the documentation steps.

## Test plan

1. Clone the `react-native-reanimated` repository
2. Follow step exactly in `Example/README.md` and observe the iOS app
will not start
3. Go back to the root of the monorepo and run `yarn build`
4. `cd Example && yarn ios` should now work successfully

---------

Co-authored-by: Tomek Zawadzki <[email protected]>
  • Loading branch information
frankcalise and tomekzaw authored Jun 11, 2024
1 parent 570feca commit 14cf3ec
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 5 deletions.
12 changes: 9 additions & 3 deletions apps/paper-example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,27 @@ cd react-native-reanimated
yarn
```

3. Install node_modules in `Example/` directory:
3. Build the library

```
yarn build
```

4. Install node_modules in `Example/` directory:

```
cd Example
yarn
```

4. Install Pods in `Example/ios/` directory:
5. Install Pods in `Example/ios/` directory:

```
cd ios
pod install
```

5. Start Metro bundler in `Example/` directory
6. Start Metro bundler in `Example/` directory

```
cd ..
Expand Down
8 changes: 6 additions & 2 deletions packages/react-native-reanimated/cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"animable",
"animatable",
"appcompat",
"barfoo",
"automagically",
"barfoo",
"bfrg",
"bokeh",
Expand All @@ -14,21 +14,24 @@
"coef",
"collapsable",
"devs",
"devs",
"easings",
"inout",
"ispreview",
"layoutable",
"lightspeed",
"nomalized",
"overdamped",
"pressable",
"RCTUI",
"REAUI",
"relayout",
"runtimes",
"snapshotting",
"springify",
"superview",
"swmansion",
"systrace",
"threejs",
"typecheck",
"uimanager",
"uimodule",
Expand All @@ -40,6 +43,7 @@
"workletized",
"workletizes",
"worklets",
"xcworkspace"
"runtimes",
"overdamped",
"automagically",
Expand Down

0 comments on commit 14cf3ec

Please sign in to comment.