@wwimmo/react-native-sketch-canvas/windows/README.md

react-native-sketch-canvas allows you to draw / sketch on both iOS and Android devices and sync the drawing data between users. Of course you can save as image.

# [module name here] Windows Implementation

## Module Installation

You can either use autolinking on react-native-windows 0.63 and later or manually link the module on earlier releases.

### Automatic install with autolinking on RNW >= 0.63

RNSketchCanvas supports autolinking. Just install the library: `yarn @wwimmo/react-native-sketch-canvas`

### Manual installation on RNW >= 0.62

1. Install with `yarn @wwimmo/react-native-sketch-canvas`
2. Open your solution in Visual Studio 2019 (eg. `windows\yourapp.sln`)
3. Right-click Solution icon in Solution Explorer > Add > Existing Project...
4. Add `node_modules\@wwimmo\react-native-sketch-canvas\windows\RNSketchCanvas\RNSketchCanvas.vcxproj`
5. Right-click main application project > Add > Reference...
6. Select `RNSketchCanvas` in Solution Projects
7. In app `pch.h` add `#include "winrt/RNSketchCanvas.h"`
8. In `App.cpp` add `PackageProviders().Append(winrt::RNSketchCanvas::ReactPackageProvider());` before `InitializeComponent();`

### Using save on Windows

On Windows, `save()` will save the resulting image in the TemporaryDirectory folder of the application.

## Module development

If you want to contribute to this module Windows implementation, first you must install the [Windows Development Dependencies](https://aka.ms/rnw-deps).

You must temporarily install the `react-native-windows` package. Versions of `react-native-windows` and `react-native` must match, e.g. if the module uses `react-native@0.62`, install `yarn add react-native-windows@^0.62 --dev`.

Now, you will be able to open corresponding `RNSketchCanvas...sln` file, e.g. `RNSketchCanvas62.sln` for `react-native-windows@0.62`.