diff --git a/README.md b/README.md index 482907fc89e..4fc326995bc 100644 --- a/README.md +++ b/README.md @@ -54,13 +54,13 @@ See the official [React Native website](https://facebook.github.io/react-native/ ## System Requirements - You can run React Native Windows UWP apps only on Windows 10 devices - - React Native Windows -[current](https://github.com/microsoft/react-native-windows/tree/master/current) supports Windows 10 SDK > [14393](https://developer.microsoft.com/en-us/windows/downloads/sdk-archive) and Windows 8.1 - - React Native Windows -[vnext](https://github.com/microsoft/react-native-windows/tree/master/vnext) currently supports Windows 10 SDK > [16299](https://developer.microsoft.com/en-us/windows/downloads/sdk-archive) + - React Native Windows -[current](https://github.com/microsoft/react-native-windows/tree/master/current) supports Windows 10 SDK >= [14393](https://developer.microsoft.com/en-us/windows/downloads/sdk-archive) and Windows 8.1 + - React Native Windows -[vnext](https://github.com/microsoft/react-native-windows/tree/master/vnext) currently supports Windows 10 SDK >= [15063](https://developer.microsoft.com/en-us/windows/downloads/sdk-archive) - You can run React Native Windows WPF apps using the [current](https://github.com/microsoft/react-native-windows/tree/master/current) implementation on Windows 7-10 so long as .NET 4.6 is installed on the end user's machine - Download [Visual Studio 2017 Community or Greater](https://www.visualstudio.com/downloads/). (Visual Studio 2015 support has been deprecated.) - You will need to start Visual Studio after it is installed to do some final setup before it can be used to build or run your React Native Windows application -*Note*: Development on React Native Windows itself currently requires Visual Studio 2017. It is not supported with VS Code, but we will gladly accept pull requests to enable a great developer experience in those environments. +*Note*: Development on React Native Windows itself currently requires Visual Studio 2017 or higher. It is not currently supported with VS Code, but work is ongoing as tracked [here](https://github.com/microsoft/vscode-react-native/issues/1007). ## Getting Started @@ -77,7 +77,7 @@ You can also begin to prototype or try out the [vnext](https://github.com/micros [React Native already has great documentation](https://facebook.github.io/react-native/docs/getting-started.html), and we're working to ensure the React Native Windows is part of that documentation story. Check out the [React documentation](http://facebook.github.io/react/) for further details about the React API in general. -For information on parity status with Android and iOS, including details on implemented and missing components and modules, along with related issues for missing features from partial implementations, go [here](current/docs/CoreParityStatus.md) for the current `react-native-windows` implementation. We are working on publishing a similar parity status for `vnext` shortly. +For information on parity status with Android and iOS, including details on implemented and missing components and modules, along with related issues for missing features from partial implementations, go [here](current/docs/CoreParityStatus.md) for the current `react-native-windows` implementation and [here](vnext/docs/ParityStatus.md) for `vnext`. ## Extending React Native diff --git a/vnext/README.md b/vnext/README.md index 2d871381fdd..40d4f1fb362 100644 --- a/vnext/README.md +++ b/vnext/README.md @@ -15,8 +15,9 @@ The `vnext` package currently supports `v0.58` of corresponding `react-native` m ## Documentation [React Native already has great documentation](https://facebook.github.io/react-native/docs/getting-started.html), and we're working to ensure the React Native Windows is part of that documentation story. Check out the [React documentation](http://facebook.github.io/react/) for further details about the React API in general. +For a live document for information on parity status with Android and iOS, including details on implemented and missing components and modules, along with related issues for missing features from partial implementations, see [Parity Status](./docs/ParityStatus.md). + Coming soon - we will be publishing more documentation including some of the following shortly: -- A live document that captures the ongoing parity status of this `vnext` implementation with Android and iOS. - Guides on how to extend native Windows capabilties in C# and C++ using `vnext` ## Getting Started @@ -28,4 +29,4 @@ If you encounter a bug with the React Native Windows C++ implementation or have Please make sure to use the [correct template](https://github.com/microsoft/react-native-windows/issues/new?labels=vnext&template=vnext.md) for issues related to the vnext `react-native-windows` implementation. ## Contributing -See [Contributing guidelines](./docs/CONTRIBUTING.md) for how to setup your fork of the repo and start a PR to contribute to React Native Windows C++. +See [Contributing guidelines](./docs/CONTRIBUTING.md) for how to setup your fork of the repo and start a PR to contribute to React Native Windows vNext. diff --git a/vnext/docs/GettingStarted.md b/vnext/docs/GettingStarted.md index 8cbbb6f0ac3..087e25ab4d1 100644 --- a/vnext/docs/GettingStarted.md +++ b/vnext/docs/GettingStarted.md @@ -3,7 +3,7 @@ This is a summary of setup steps needed to install and work with React Native for Windows (vnext). See the [React Native Getting Started Guide](http://facebook.github.io/react-native/docs/getting-started.html) for React Native details and see [Getting Started Guide - current](https://github.com/microsoft/react-native-windows/blob/master/current/docs/GettingStarted.md) for working with the `current` React Native for Windows implementation. ## System requirements -* You can run React-Native for Windows10 apps only on Windows 10 devices and Windows version: 10.0.16299.0 or higher. +* You can run React-Native for Windows10 apps only on Windows 10 devices and Windows version: 10.0.15063.0 or higher. * [Visual Studio 2017](https://www.visualstudio.com/downloads) with the following options: * Workloads * Universal Windows Platform development @@ -12,7 +12,8 @@ This is a summary of setup steps needed to install and work with React Native fo * Individual Components * Development activities * Node.js development support - * SDKs, libraries, and frameworks + * SDKs, libraries, and frameworks per your versioning needs + * Windows 10 SDK (10.0.15063.0) * Windows 10 SDK (10.0.16299.0) * Windows 10 SDK (10.0.17763.0) @@ -160,6 +161,6 @@ You now see your new app and Chrome should have loaded `http://localhost:8081/de - RNTester: JavaScript file: `lib\RNTester\RNTesterApp.uwp` App Name: `RNTesterApp` ## Troubleshooting -* Use VS 2017 when using the CLI. Issue [#2320](https://github.com/microsoft/react-native-windows/issues/2320) tracks support for CLI with VS 2019. * If after running the app the packager does not update (or) app does not show React Native content - close the packager command prompt window and the app, run `yarn start` and run the app again. Issue [#2311](https://github.com/microsoft/react-native-windows/issues/2311) is tracking a known issue on this. * If you get a red error box in your UWP app window with the error message : `ERROR: Instance failed to start. A connection with the server cannot be established`, make sure you have the packager running using `yarn start` and run the app again. +* If you are trying to run your `react-native` app on iOS/Android while using this `vnext` implementation for developing/running on Windows, you will encounter errors while running the app for other platforms. This will be fixed once we address Issues [#2264](https://github.com/microsoft/react-native-windows/issues/2264) and [#2535](https://github.com/microsoft/react-native-windows/issues/2535). Until this is fixed, please refer to [this comment](https://github.com/microsoft/react-native-windows/issues/2515#issuecomment-497375198) which describes the workaround for running on other platforms while developing for windows using `vnext`.