You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-14Lines changed: 14 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -20,15 +20,15 @@ The core library source code is in this repo. If you are looking for the *source
20
20
21
21
1. To provide the fixes necessary to run Node.js on mobile operating systems.
22
22
1. To investigate which features need to be added to Node.js in order to make it a useful tool for mobile app development.
23
-
1. To diverge as little as possible from nodejs/node and nodejs/node-chakracore, while fulfilling goals (1) and (2).
23
+
1. To diverge as little as possible from nodejs/node, while fulfilling goals (1) and (2).
24
24
25
25
## Download
26
26
Binaries for Android and iOS are available at https://github.com/janeasystems/nodejs-mobile/releases.
27
27
28
28
## Documentation
29
29
Documentation can be found on the [project website](https://code.janeasystems.com/nodejs-mobile). Sample code is available in the [samples repo](https://github.com/janeasystems/nodejs-mobile-samples/).
30
30
31
-
***Disclaimer:*** documentation found in this repository is currently unchanged from the parent repository and may only be applicable to node-chakracore.
31
+
***Disclaimer:*** documentation found in this repository is currently unchanged from the parent repository and may only be applicable to upstream node.
It will create a `android-ndk-r20b` folder. Save that path for later.
71
+
It will create a `android-ndk-r21` folder. Save that path for later.
72
72
73
73
### Building the Android library on Linux or macOS:
74
74
@@ -82,11 +82,11 @@ git checkout mobile-master
82
82
83
83
#### 2a) Using the Android helper script:
84
84
85
-
The `tools/android_build.sh` script takes as first argument the Android NDK path (in our case is `~/android-ndk-r20b`). The second argument is optional and is the target architecture, which can be one of the following: `arm`, `x86`, `arm64` or `x86_64`. If no target architecture is provided, it will build all available architectures.
85
+
The `tools/android_build.sh` script takes as first argument the Android NDK path (in our case is `~/android-ndk-r21`). The second argument is optional and is the target architecture, which can be one of the following: `arm`, `x86`, `arm64` or `x86_64`. If no target architecture is provided, it will build all available architectures.
86
86
Run:
87
87
88
88
```sh
89
-
./tools/android_build.sh ~/android-ndk-r20b
89
+
./tools/android_build.sh ~/android-ndk-r21
90
90
```
91
91
92
92
When done, each built shared library will be placed in `out_android/$(ARCHITECTURE)/libnode.so`.
@@ -95,7 +95,7 @@ When done, each built shared library will be placed in `out_android/$(ARCHITECTU
95
95
Run the `android-configure` script to configure the build with the path to the downloaded NDK and the desired target architecture.
96
96
97
97
```sh
98
-
source ./android-configure ../android-ndk-r20b arm
98
+
source ./android-configure ../android-ndk-r21 arm
99
99
```
100
100
101
101
Start the build phase:
@@ -157,7 +157,7 @@ git checkout mobile-master
157
157
./tools/ios_framework_prepare.sh
158
158
```
159
159
160
-
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.
160
+
That will configure `gyp` to build Node.js and its dependencies as static libraries for iOS on the arm64 and x64 architectures, using the `v8` engine configured to start 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.
161
161
162
162
The helper script builds the `tools/ios-framework/NodeMobile.xcodeproj` Xcode project into three frameworks:
163
163
- The framework to run on iOS devices: `out_ios/Release-iphoneos/NodeMobile.framework`
@@ -167,7 +167,7 @@ The helper script builds the `tools/ios-framework/NodeMobile.xcodeproj` Xcode pr
167
167
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.
168
168
169
169
## Running tests
170
-
Please see the [TESTING.md](https://github.com/janeasystems/nodejs-mobile/blob/mobile-master/doc_mobile/TESTING.md) file in the `doc_mobile` folder in this source distribution.
170
+
Please see the [TESTING.md](./doc_mobile/TESTING.md) file in the `doc_mobile` folder in this source distribution.
171
171
172
172
## Contributing
173
-
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.
173
+
Please see the [CONTRIBUTING](./doc_mobile/CONTRIBUTING.md) file in the `doc_mobile` folder in this source distribution.
Copy file name to clipboardExpand all lines: doc_mobile/CONTRIBUTING.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
# Contributing to Node.js for Mobile Apps
2
2
3
3
## Code Contributions
4
-
Only changes that fall within the scope of the [project goals](https://github.com/janeasystems/nodejs-mobile/blob/mobile-master/README.md#project-goals) will be accepted.
4
+
Only changes that fall within the scope of the [project goals](../README.md#project-goals) will be accepted.
5
5
6
6
If you want to implement a major feature or a semantical change, please open an issue for discussion first. For minor fixes, feel free to just open a pull request.
You'll need to build nodejs-mobile, so [its prerequisites should also be installed on your system.](https://github.com/janeasystems/nodejs-mobile#prerequisites-to-build-the-ios-framework-library-on-macos)
20
+
You'll need to build nodejs-mobile, so [its prerequisites should also be installed on your system.](../README.md#prerequisites-to-build-the-ios-framework-library-on-macos)
@@ -76,11 +76,11 @@ You'll need [Android Studio](https://developer.android.com/studio/install.html)
76
76
77
77
You should set the Environment variables required to build Android Applications from the command line: the `ANDROID_HOME` variable pointing to your `android-sdk` path and the `ANDROID_NDK_HOME` variable pointing to the installed NDK path (it usually is `$ANDROID_HOME/ndk-bundle`) . You should also add `$ANDROID_HOME/platform-tools`, `$ANDROID_HOME/tools` and `$ANDROID_HOME/tools/bin` to the `PATH` environment variable.
78
78
79
-
You'll need to build nodejs-mobile, so [its prerequisites should also be installed on your system.](https://github.com/janeasystems/nodejs-mobile#prerequisites-to-build-the-android-library-on-linux-ubuntudebian)
79
+
You'll need to build nodejs-mobile, so [its prerequisites should also be installed on your system.](../README.md#prerequisites-to-build-the-android-library-on-linux-ubuntudebian)
0 commit comments