Skip to content

Commit c74b36a

Browse files
committed
Moar readme updates.
1 parent 231ebf2 commit c74b36a

File tree

2 files changed

+36
-2
lines changed

2 files changed

+36
-2
lines changed

README.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,29 @@ This project is based on [facebook/android-jsc](https://github.com/facebook/andr
88

99
## Requirements
1010

11-
You can try the provided Docker image.
12-
To use it prefix each command with `docker run -vLOCAL_WORKDIR_PATH:/bitrise/src --rm swmansion/jsc-android-buildscripts`.
11+
12+
There is a huge list of requirements that needs to be installed on your system in order to be able to cross-compile JSC for android. To simplify the process of setting up the environment we provide a docker image that comes with everything you will need. If you decide to use our docker the only thing you need to do is to prefix each command with this:
13+
```sh
14+
docker run -vLOCAL_WORKDIR_PATH:/bitrise/src --rm swmansion/jsc-android-buildscripts
15+
```
16+
17+
##### Example:
18+
19+
```sh
20+
docker run -vLOCAL_WORKDIR_PATH:/bitrise/src --rm swmansion/jsc-android-buildscripts ./fetch_sources.sh
21+
```
22+
23+
#### Don't want to use docker
24+
25+
As mentioned the list of dependencies is huge, we tried to list everything what's needed below:
26+
- Android SDK & NDK
27+
- ruby (2.3), python (2.7), node (7.x), git, svn, gperf
28+
- cmake installed via Android SDK manager
1329

1430
## Build instructions
1531

32+
> **IMPORTANT:** Remember to prefix each command with an appropriate docker instruction given above when using our docker image
33+
1634
1. `git clone https://github.com/SoftwareMansion/jsc-android-buildscripts.git .`
1735
2. `./fetch_sources.sh`
1836
3. `./icu-prep.sh`
@@ -24,10 +42,26 @@ The maven repo containing android-jsc aar will be available at `LOCAL_WORKDIR_PA
2442

2543
## Distribution
2644

45+
(TODO)
46+
2747
## How to use it with React Native
2848

49+
We will be working on getting react-native core updated in order to use new version of JSC. Once that gets approved the only thing you will need to do is to update your RN version! Until then you can fork react-native and patch it with the following patch: (TODO)
50+
2951
## Testing
3052

53+
As a part of this project we provide a patch to react-native source code that allows for measuring react native application cold-start time. The methodology behind this test is to modify the part of the code that is responsible for loading JS bundle into the JS VM such that we measure and store the execution time, then we modify the process of instantiating the bridge in a way that allows for running in multiple times. To learn more about how the perf tests work and how to perform them refer to [this document](../blob/master/TESTING). Results for Samsung Galaxy S4 are presented below:
54+
55+
| | android-jsc (r174650) | new JSC (r216995) |
56+
| ------------------- |----------------------:| -----------------:|
57+
| cold start time | 427 ms | 443 ms |
58+
| binary size (x86) | (TODO) | (TODO) |
59+
| binary size (armv7) | (TODO) | (TODO) |
60+
| binary size (arm64) | N/A | (TODO) |
61+
3162
## Credits
3263

3364
This project has been built in cooperation between [Expo.io](https://expo.io/) and [Software Mansion](https://swmansion.com)
65+
66+
![Expo.io](https://avatars2.githubusercontent.com/u/12504344?v=3&s=200 | width=200)
67+
![Software Mansion](https://avatars1.githubusercontent.com/u/6952717?v=3&s=200 | width=200)

TESTING.md

Whitespace-only changes.

0 commit comments

Comments
 (0)