Skip to content

Commit

Permalink
docs: update README.md for new iOS framework name
Browse files Browse the repository at this point in the history
The iOS framework name was changed from libnode to NodeMobile.
This commit updates the iOS build instructions to reflect that
name change.

Refs: JaneaSystems@ec36bb6
  • Loading branch information
jaimecbernardo committed Dec 15, 2017
1 parent ec36bb6 commit f1ed329
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,14 +149,14 @@ git checkout mobile-master
./tools/ios_framework_prepare.sh
```

That will configure `gyp` to build Node.js and its dependencies as static libraries for iOS on the arm64 and x64 architectures, using the `ChakraCore` engine with JIT disabled. The script copies those libraries to `tools/ios-framework/bin/arm64` and `tools/ios-framework/bin/x64`, respectively. It also merges them into static libraries that contain strips for both architectures, which will be placed in `tools/ios-framework/bin` and used by the `tools/ios-framework/nodeLib.xcodeproj` Xcode project.
That will configure `gyp` to build Node.js and its dependencies as static libraries for iOS on the arm64 and x64 architectures, using the `ChakraCore` engine with JIT disabled. The script copies those libraries to `tools/ios-framework/bin/arm64` and `tools/ios-framework/bin/x64`, respectively. It also merges them into static libraries that contain strips for both architectures, which will be placed in `tools/ios-framework/bin` and used by the `tools/ios-framework/NodeMobile.xcodeproj` Xcode project.

The helper script builds the `tools/ios-framework/nodeLib.xcodeproj` Xcode project into three frameworks:
- The framework to run on iOS devices: `out_ios/Release-iphoneos/libnode.framework`
- The framework to run on the iOS simulator: `out_ios/Release-iphonesimulator/libnode.framework`
- The universal framework, that runs on iOS devices and simulators: `out_ios/Release-universal/libnode.framework`
The helper script builds the `tools/ios-framework/NodeMobile.xcodeproj` Xcode project into three frameworks:
- The framework to run on iOS devices: `out_ios/Release-iphoneos/NodeMobile.framework`
- The framework to run on the iOS simulator: `out_ios/Release-iphonesimulator/NodeMobile.framework`
- The universal framework, that runs on iOS devices and simulators: `out_ios/Release-universal/NodeMobile.framework`

While the universal framework is useful for faster Application development, due to supporting both iOS devices and simulators, frameworks containing simulator strips will not be accepted on the App Store. Before trying to submit your application, it would be advisable to use the `Release-iphoneos/libnode.framework` in your submission archive or strip the x64 slices from the universal framework's binaries before submitting.
While the universal framework is useful for faster Application development, due to supporting both iOS devices and simulators, frameworks containing simulator strips will not be accepted on the App Store. Before trying to submit your application, it would be advisable to use the `Release-iphoneos/NodeMobile.framework` in your submission archive or strip the x64 slices from the universal framework's binaries before submitting.

## Contributing
Please see the [CONTRIBUTING](https://github.com/janeasystems/nodejs-mobile/blob/mobile-master/doc_mobile/CONTRIBUTING.md) file in the `doc_mobile` folder in this source distribution.
Expand Down

0 comments on commit f1ed329

Please sign in to comment.