diff --git a/README.md b/README.md index cbc480fc7b1..5145a32ee2f 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@

-![Hero Image with Logo](./.github/hero2.png) +![Hero Image with Logo](https://github.com/microsoft/react-native-windows/raw/master/.github/hero2.png) > See the official [React Native website](https://reactnative.dev/) for an introduction to React Native. @@ -57,7 +57,7 @@ Search the [existing issues](https://github.com/microsoft/react-native-windows/i The GitHub issues are intended for bug reports and feature requests. For help and questions with using the React Native Windows plugin please make use of the resources listed our main README's the [Getting Help](https://github.com/microsoft/react-native-windows#getting-help) section. ## 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 for Windows. +See [Contributing guidelines](https://github.com/microsoft/react-native-windows/blob/master/docs/contributing.md) for how to setup your fork of the repo and start a PR to contribute to React Native for Windows. [Good First Task](https://github.com/microsoft/react-native-windows/labels/Good%20First%20Task) and [help wanted](https://github.com/microsoft/react-native-windows/labels/help%20wanted) are great starting points for PRs. diff --git a/change/react-native-windows-2020-04-27-11-58-10-readme.json b/change/react-native-windows-2020-04-27-11-58-10-readme.json new file mode 100644 index 00000000000..2ca20ee2410 --- /dev/null +++ b/change/react-native-windows-2020-04-27-11-58-10-readme.json @@ -0,0 +1,8 @@ +{ + "type": "prerelease", + "comment": "Use readme file from root of repo for react-native-windows", + "packageName": "react-native-windows", + "email": "acoates@microsoft.com", + "dependentChangeType": "patch", + "date": "2020-04-27T18:58:10.453Z" +} diff --git a/vnext/.gitignore b/vnext/.gitignore index 6377e5c79c4..30a7d146fa2 100644 --- a/vnext/.gitignore +++ b/vnext/.gitignore @@ -85,3 +85,6 @@ temp /coverage /third-party /packages/ + +# Copied from root as part of build +/README.md \ No newline at end of file diff --git a/vnext/README.md b/vnext/README.md deleted file mode 100644 index eed88ab92d0..00000000000 --- a/vnext/README.md +++ /dev/null @@ -1,33 +0,0 @@ -# ReactNative for Windows -![Hero Image with Logo](https://raw.githubusercontent.com/microsoft/react-native-windows/master/.github/hero2.png) - -> See the official [React Native website](https://facebook.github.io/react-native/) for an introduction to React Native. See [main landing page](https://github.com/microsoft/react-native-windows) for more details on overall direction of `react-native-windows`. - -[React Native](https://reactnative.dev) is a framework developed by Facebook that enables you to build world-class application experiences on native platforms using a consistent developer experience based on JavaScript and [React](https://reactjs.org/). The focus of React Native is on developer efficiency across all the platforms you care about - learn once, write anywhere. - -This repository adds support for the [Windows 10 SDK](https://developer.microsoft.com/en-us/windows/downloads), which allows you to build apps for [all devices supported by Windows 10](https://developer.microsoft.com/en-us/windows/get-started-windows-10) including PCs, tablets, 2-in-1s, Xbox, Mixed reality devices etc. - -## Status and roadmap -[Check out our blog](https://microsoft.github.io/react-native-windows/blog/) If you'd like to stay up to date on the status of React Native for Windows and check out current and past roadmaps, We will post all new releases, updates and general news about the project there. - -## Documentation -[React Native already has great documentation](https://reactnative.dev/docs/getting-started.html) and we're working to ensure the React Native Windows is part of that documentation story. - -[React Native for Windows](https://microsoft.github.io/react-native-windows/) has it's own separate documentation site where Windows and Mac specific information, like API docs and blog updates live. - -## Getting Started -See [Getting Started Guide for React Native Windows C++](https://microsoft.github.io/react-native-windows/docs/getting-started). - -## Opening issues -If you encounter a bug with the React Native Windows plugin, we would like to hear about it! - -Search the [existing issues](https://github.com/microsoft/react-native-windows/issues) and try to make sure your problem doesn’t already exist before opening a new issue. If your issue doesn't exist yet, try to make sure you provide as much information as possible to us so we can help you sooner. It’s helpful if you include information like: - -- The version of Windows, React Native, React Native Windows plugin, and device family (i.e., mobile, desktop, Xbox, etc.) where you ran into the issue. -- A stack trace and reduced repro case when possible. -- Ensure the [appropriate template](https://github.com/microsoft/react-native-windows/issues/new?labels=vnext&template=vnext.md) is used when filing your issue(s). - -The GitHub issues are intended for bug reports and feature requests. For help and questions with using the React Native Windows plugin please make use of the resources listed our main README's the [Getting Help](https://github.com/microsoft/react-native-windows#getting-help) section. - -## 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 vNext. diff --git a/vnext/just-task.js b/vnext/just-task.js index dc0c2e9a25e..bf440f6c14f 100644 --- a/vnext/just-task.js +++ b/vnext/just-task.js @@ -20,6 +20,7 @@ const { cleanTask, } = require('just-scripts'); const {execSync} = require('child_process'); +const fs = require('fs'); const libPath = path.resolve(process.cwd(), 'lib'); const srcPath = path.resolve(process.cwd(), 'src'); @@ -61,6 +62,13 @@ task('initRNLibraries', () => { require('./Scripts/copyRNLibraries').copyRNLibraries(__dirname); }); +task('copyReadmeFromRoot', () => { + fs.copyFileSync( + path.resolve(__dirname, '../README.md'), + path.resolve(__dirname, 'README.md'), + ); +}); + task('ts', () => { return tscTask({ pretty: true, @@ -86,6 +94,7 @@ task( condition('clean', () => true || argv().clean), 'initRNLibraries', 'copyFlowFiles', + 'copyReadmeFromRoot', 'ts', 'codegen', condition('apiExtractorVerify', () => argv().ci),