From 8079592fbf1732e19db5694c1e072cd13c63dcee Mon Sep 17 00:00:00 2001 From: Marc Rousavy Date: Tue, 23 Feb 2021 12:04:27 +0100 Subject: [PATCH] Create README.md --- ios/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 ios/README.md diff --git a/ios/README.md b/ios/README.md new file mode 100644 index 0000000..966cf8a --- /dev/null +++ b/ios/README.md @@ -0,0 +1,16 @@ +# ios + +This folder contains the iOS-platform-specific code for react-native-vision-camera. + +## Prerequesites + +1. Install need [SwiftFormat](https://github.com/nicklockwood/SwiftFormat) and [SwiftLint](https://github.com/realm/SwiftLint) + ```sh + brew install swiftformat swiftlint + ``` + +## Getting Started + +It is recommended that you work on the code using the Example project (`example/ios/VisionCameraExample.xcworkspace`), since that always includes the React Native header files, plus you can easily test changes that way. + +You can however still edit the library project here by opening `VisionCamera.xcodeproj`.