From 8abfb5e0e2015a0b8a80cba81ccf249df275adcb Mon Sep 17 00:00:00 2001 From: Martin Konicek Date: Mon, 12 Oct 2015 16:16:39 +0100 Subject: [PATCH] Add docs for examples --- Examples/Movies/README.md | 41 +++++++++++++++++++++++++++++++++++ Examples/UIExplorer/README.md | 41 +++++++++++++++++++++++++++++++++++ 2 files changed, 82 insertions(+) create mode 100644 Examples/Movies/README.md create mode 100644 Examples/UIExplorer/README.md diff --git a/Examples/Movies/README.md b/Examples/Movies/README.md new file mode 100644 index 000000000..b63c77717 --- /dev/null +++ b/Examples/Movies/README.md @@ -0,0 +1,41 @@ +# Movies app + +The Movies app is a demonstration of basic concepts, such as fetching data, rendering a list of data including images, and navigating between different screens. + +## Running this app + +Before running the app, make sure you ran: + + cd react-native + npm install + +### Running on iOS + +Mac OS and Xcode are required. + +- Open `Examples/Movies/Movies.xcodeproj` in Xcode +- Hit the Run button + +See [Running on device](https://facebook.github.io/react-native/docs/running-on-device-ios.html) if you want to use a physical device. + +### Running on Android + +You'll need to have all the [prerequisites](https://github.com/facebook/react-native/tree/master/ReactAndroid#prerequisites) (SDK, NDK) for Building React Native installed. + +Start an Android emulator ([Genymotion](https://www.genymotion.com) is recommended). + + cd react-native + ./gradlew :Examples:Movies:android:app:installDebug + ./packager/packager.sh + +_Note: Building for the first time can take a while._ + +Open the Movies app in your emulator. + +See [Running on Device](https://facebook.github.io/react-native/docs/running-on-device-android.html) in case you want to use a physical device. + +## Built from source + +Building the app on both iOS and Android means building the React Native framework from source. This way you're running the latest native and JS code the way you see it in your clone of the github repo. + +This is different from apps created using `react-native init` which have a dependency on a specific version of React Native JS and native code, declared in a `package.json` file (and `build.gradle` for Android apps). diff --git a/Examples/UIExplorer/README.md b/Examples/UIExplorer/README.md new file mode 100644 index 000000000..ea1f4170a --- /dev/null +++ b/Examples/UIExplorer/README.md @@ -0,0 +1,41 @@ +# UIExplorer + +The UIExplorer is a sample app that showcases React Native views and modules. + +## Running this app + +Before running the app, make sure you ran: + + cd react-native + npm install + +### Running on iOS + +Mac OS and Xcode are required. + +- Open `Examples/UIExplorer/UIExplorer.xcodeproj` in Xcode +- Hit the Run button + +See [Running on device](https://facebook.github.io/react-native/docs/running-on-device-ios.html) if you want to use a physical device. + +### Running on Android + +You'll need to have all the [prerequisites](https://github.com/facebook/react-native/tree/master/ReactAndroid#prerequisites) (SDK, NDK) for Building React Native installed. + +Start an Android emulator ([Genymotion](https://www.genymotion.com) is recommended). + + cd react-native + ./gradlew :Examples:UIExplorer:android:app:installDebug + ./packager/packager.sh + +_Note: Building for the first time can take a while._ + +Open the UIExplorer app in your emulator. + +See [Running on Device](https://facebook.github.io/react-native/docs/running-on-device-android.html) in case you want to use a physical device. + +## Built from source + +Building the app on both iOS and Android means building the React Native framework from source. This way you're running the latest native and JS code the way you see it in your clone of the github repo. + +This is different from apps created using `react-native init` which have a dependency on a specific version of React Native JS and native code, declared in a `package.json` file (and `build.gradle` for Android apps).