Skip to content

Commit

Permalink
Update getting started to note about Windows (#869)
Browse files Browse the repository at this point in the history
Co-authored-by: Satyajit Sahoo <satyajit.happy@gmail.com>
  • Loading branch information
alexanderblackh and satya164 committed Nov 30, 2020
1 parent 8e16420 commit a5782bb
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion versioned_docs/version-5.x/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ npm install react-native-reanimated react-native-gesture-handler react-native-sc

> Note: You might get warnings related to peer dependencies after installation. They are usually caused by incorrect version ranges specified in some packages. You can safely ignore most warnings as long as your app builds.
> Note: If using this project with [react-native-windows](https://github.com/microsoft/react-native-windows), omit `react-native-gesture-handler`.
From React Native 0.60 and higher, [linking is automatic](https://github.com/react-native-community/cli/blob/master/docs/autolinking.md). So you **don't need to run** `react-native link`.

If you're on a Mac and developing for iOS, you need to install the pods (via [Cocoapods](https://cocoapods.org/)) to complete the linking.
Expand All @@ -65,7 +67,7 @@ To finalize installation of `react-native-gesture-handler`, add the following at
import 'react-native-gesture-handler';
```

> Note: If you skip this step, your app may crash in production even if it works fine in development.
> Note: If you are building for Android or iOS, do not skip this step, or your app may crash in production even if it works fine in development. This is not applicable to other platforms.
Now, we need to wrap the whole app in `NavigationContainer`. Usually you'd do this in your entry file, such as `index.js` or `App.js`:

Expand Down

0 comments on commit a5782bb

Please sign in to comment.