diff --git a/Example/README.md b/Example/README.md index 916893d7591..167ac7d816b 100644 --- a/Example/README.md +++ b/Example/README.md @@ -1,20 +1,69 @@ -## Running the example +## Running the Example app -- clone the repository -- `yarn install` at main directory -- `cd Example/` -- `yarn install` again +1. Clone the repository: + +``` +git clone https://github.com/software-mansion/react-native-reanimated +cd react-native-reanimated +``` + +2. Install node_modules in project root directory: + +``` +yarn +``` + +3. Install node_modules in `Example/` directory: + +``` +cd Example +yarn +``` + +4. Install Pods in `Example/ios/` directory: + +``` +cd ios +pod install +``` + +5. Start Metro bundler in `Example/` directory + +``` +cd .. +yarn start +``` ### Running on iOS -- `yarn pod-install` - to install pods -- `yarn react-native run-ios` - to run the app +You can either open the workspace in Xcode and launch the app from there: + +``` +open ios/ReanimatedExample.xcworkspace +``` + +or build and run directly from the command line: + +``` +yarn react-native run-ios +``` + +**Important:** You will need to have an iOS device or simulator connected. ### Running on Android -- [install NDK in version 21.3.6528147 or higher](https://developer.android.com/studio/projects/install-ndk) -- `yarn react-native run-android` - to run the app +You can either open the project with Android Studio and launch the app from there: + +``` +open -a "Android Studio" android/ +``` + +or build and run directly from the command line: + +``` +yarn react-native run-android +``` -**Note:** Android compiles fairly long due to native dependencies. To shorten consecutive builds, load the project into android studio and run it from there. Same applies to iOS so you can use XCode for running the example. +**Note:** You can also pass `--active-arch-only` flag to build the app only for the current architecture to significantly shorten build time. -**Important:** You will need to have an Android or iOS device or emulator connected. +**Important:** You will need to have an Android device or emulator connected.