From c69e737f19888cf65d22f90a31655a684c22e6af Mon Sep 17 00:00:00 2001 From: Lorenzo Blasa Date: Wed, 7 Sep 2022 03:53:50 -0700 Subject: [PATCH] README update Summary: Add instructions for building and running our RNW sample application. Reviewed By: antonk52 Differential Revision: D39305056 fbshipit-source-id: 2adb41d713381c1b79ea5fe55a4f8a40d43e7f4c --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index 6fb026b60..77b551455 100644 --- a/README.md +++ b/README.md @@ -153,6 +153,38 @@ If this is the first time running, you will also need to run `pod install --repo-update` from the `react-native/ReactNativeFlipperExample/ios` folder. +### React Native Windows (Experimental) + +An experimental version of Flipper for React Native Windows is available. The +following steps prepare the React Native Flipper project: + +```bash +cd react-native/react-native-flipper +vcpkg install openssl:x64-uwp openssl:arm-uwp +vcpkg integrate install +yarn install +cd windows +nuget install ReactNativeFlipper/packages.config +``` + +In a nutshell, [vcpkg](https://vcpkg.io/) is used to install +[OpenSSL](https://www.openssl.org/). Nuget is used to install +[Boost](https://www.boost.org/). + +Then, the sample application can be built and run as follows: + +```bash +cd ../../ReactNativeFlipperExample +yarn install +yarn relative-deps +npx react-native run-windows +``` + +At the moment there's no available package for React Native Flipper. This means +that to integrate Flipper with any other existing applications, an explicit +reference to the project needs to be added just as is done with the sample +application. + ## JS SDK + Sample React app ```bash