added readme

Author: swittk

README.md

@@ -4,6 +4,23 @@ title: Home
 nav_order: 1
 ---
 
+# This is a fork of MediaPipe to demonstrate building MediaPipe as a Framework for iOS, in this case, the FaceMesh model
+- This builds an XCFramework into ./frameworkbuild/FaceMeshIOSLibFramework/xcframework
+    - The XCFramework contains both arm64 and x86_64 (iOS Simulator) parts, so you can use this on both real devices and on the iOS simulator
+- I've created the Objective-C file for the framework in //mediapipe/examples/ios/facemeshioslib
+
+# Usage
+## Building
+- prerequisites
+    - You need to have Google's Bazel installed. Personally I install via node (`npm install -g bazel`).
+- run `./BUILD_FACE_MESH_XCFRAMEWORK.sh`, the resulting framework should then appear in ./frameworkbuild/FaceMeshIOSLibFramework/xcframework/FaceMeshIOSLibFramework.xcframework
+    - Copy the framework and use it in your projects. You're welcome.
+    - Framework usage : `#import <FaceMeshIOSLibFramework/FaceMeshIOSLibFramework.h>`
+        - only one class : FaceMeshIOSLib
+            - delegate callback gives you an array of detected faces (But there's only one face configured in my graph.. so there's at most length 1)
+                - each face is an array of 468 `FaceMeshIOSLibFaceLandmarkPoint` points (x,y,z)
+
+
 ![MediaPipe](docs/images/mediapipe_small.png)
 
 --------------------------------------------------------------------------------

mediapipe/examples/ios/facemeshioslib/FaceMeshIOSLib.h

@@ -1,16 +1,4 @@
-// Copyright 2019 The MediaPipe Authors.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
+// Copyright 2021 Switt Kongdachalert
 
 #import <CoreVideo/CoreVideo.h>
 #import <Foundation/Foundation.h>

mediapipe/examples/ios/facemeshioslib/FaceMeshIOSLib.mm

@@ -1,16 +1,4 @@
-// Copyright 2019 The MediaPipe Authors.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
+// Copyright 2021 Switt Kongdachalert
 
 #import "FaceMeshIOSLib.h"
 #import "mediapipe/objc/MPPCameraInputSource.h"