Skip to content

Commit 256084e

Browse files
typos, spelling
1 parent 54c41c1 commit 256084e

File tree

2 files changed

+28
-29
lines changed

2 files changed

+28
-29
lines changed

Modules/@babylonjs/react-native/README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ The minimum Android SDK version is 18. This must be set as `minSdkVersion` in th
1616

1717
### iOS Configuration
1818

19-
The minimum deployment target version is 12. This must be set as `iOS Deployment Target` in the consuming project's `project.pbxproj`, and must also be set as `platform` in the consuming project's `podfile`.
20-
Make sure `pod install` is called from ios folder after npm install.
19+
The minimum deployment target version is 12. This must be set as `iOS Deployment Target` in the consuming project's `project.pbxproj`, and must also be set as `platform` in the consuming project's `Podfile`.
20+
Make sure `pod install` is called from the ios folder after npm install.
2121

2222
#### Workspace
23-
In your app workspace, add a reference to BabylonReactNative project by add these lines:
23+
In your app workspace, add a reference to BabylonReactNative project by adding these lines:
2424
```
2525
<FileRef
2626
location = "group:../node_modules/@babylonjs/react-native/Build/iOS/ReactNativeBabylon.xcodeproj">
@@ -29,36 +29,36 @@ In your app workspace, add a reference to BabylonReactNative project by add thes
2929
to your app `xcworkspace/content.xcworkspacedata` file.
3030

3131
#### CMake
32-
iOS NPM needs CMake 3.26+ to be present to generate Xcode project. If CMake is not in default path(or an older version that can't be upgraded) a local version can be set and used with this variable:
32+
iOS NPM needs CMake 3.26+ to be present to generate Xcode project. If CMake is not in the default path (or an older version that can't be upgraded) a local version can be set and used with this variable:
3333

3434
```
3535
export BABYLON_CMAKE_PATH=/path/to/a/more/recent/cmake
3636
```
3737

38-
To disable post install CMake generation, set this variable before runnong `npm install`:
38+
To disable post install CMake generation, set this variable before running `npm install`:
3939
```
4040
export BABYLON_NO_CMAKE_POSTINSTALL=1
4141
```
4242

4343
### Plugins selection
4444

45-
Plugins can be disabled at build time. They are all enabled by default and disabling is done with Environment variables:
45+
Plugins can be disabled at build time. They are all enabled by default and disabling is done with environment variables:
4646

4747
To disable Camera plugin:
4848
```
49-
export BABYLON_NATIVE_PLUGIN_NATIVECAMERA = 0
49+
export BABYLON_NATIVE_PLUGIN_NATIVECAMERA=0
5050
```
5151

5252
For Native XR:
5353
```
54-
export BABYLON_NATIVE_PLUGIN_NATIVEXR = 0
54+
export BABYLON_NATIVE_PLUGIN_NATIVEXR=0
5555
```
5656

5757
### Platform Native Packages
5858

5959
Starting with BabylonReactNative NPM 2.0.0+, one single package is available for iOS, Android and Windows versus multiple packages before.
6060

61-
Babylon.js minimal version :
61+
Babylon.js minimal version:
6262

6363
|BabylonReactNative version | Babylon.js version | BabylonNative commit |
6464
| ----------- | ------------------------ | --- |
@@ -136,18 +136,18 @@ e.g.
136136

137137
Note: Currently only one `EngineView` can be active at any given time. Multi-view will be supported in a future release.
138138

139-
The Android specific `androidView` property can help set the type of the view used for rendering. Depending on user needs and performance, refer to the table below. [`TextureView`](https://developer.android.com/reference/android/view/TextureView) can be inserted anywhere in the view hierarchy, but is less efficient. [`SurfaceView`](https://developer.android.com/reference/android/view/SurfaceView) can only be full above or fully below the rest of the UI, but is more efficient.
139+
The Android specific `androidView` property can help set the type of the view used for rendering. Depending on user needs and performance, refer to the table below. [`TextureView`](https://developer.android.com/reference/android/view/TextureView) can be inserted anywhere in the view hierarchy, but is less efficient. [`SurfaceView`](https://developer.android.com/reference/android/view/SurfaceView) can only be fully above or fully below the rest of the UI, but is more efficient.
140140

141141
| isTransparent | androidView | Description |
142142
| ----------- | ------------------------ | ----------- |
143143
| False | TextureView | Opaque TextureView.
144-
| False | SurfaceView | Simple surfaceView (default when no `androidView` set with `isTransparent=false`).
144+
| False | SurfaceView | Simple SurfaceView (default when no `androidView` set with `isTransparent=false`).
145145
| False | SurfaceViewZTopMost | SurfaceView with [ZTopMost](https://developer.android.com/reference/android/view/SurfaceView#setZOrderOnTop(boolean)) set to `true`.
146146
| False | SurfaceViewZMediaOverlay | SurfaceView with [ZMediaOverlay](https://developer.android.com/reference/android/view/SurfaceView#setZOrderMediaOverlay(boolean)) set to `true`.
147147
| True | TextureView | Transparent TextureView.
148148
| True | SurfaceView | SurfaceView will stay opaque
149-
| True | SurfaceViewZTopMost | SurfaceView with [ZTopMost](https://developer.android.com/reference/android/view/SurfaceView#setZOrderOnTop(boolean)) set to `true`. Transparent but top most. (default when no `androidView` set with `isTransparent=true`)
150-
| True | SurfaceViewZMediaOverlay | SurfaceView with [ZMediaOverlay](https://developer.android.com/reference/android/view/SurfaceView#setZOrderMediaOverlay(boolean)) set to `true`. Only Transparent on top of other SurfaceViews.
149+
| True | SurfaceViewZTopMost | SurfaceView with [ZTopMost](https://developer.android.com/reference/android/view/SurfaceView#setZOrderOnTop(boolean)) set to `true`. Transparent but topmost. (default when no `androidView` set with `isTransparent=true`)
150+
| True | SurfaceViewZMediaOverlay | SurfaceView with [ZMediaOverlay](https://developer.android.com/reference/android/view/SurfaceView#setZOrderMediaOverlay(boolean)) set to `true`. Only transparent on top of other SurfaceViews.
151151

152-
More infos on TextureView Vs SurfaceView performance here:
153-
https://developer.android.com/reference/android/view/TextureView
152+
More information on TextureView vs SurfaceView performance here:
153+
https://developer.android.com/reference/android/view/TextureView

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@ Note: Official support for React Native frameworks, like Expo, is not provided b
3535

3636
## Contributing
3737

38-
This quick overview will help you get started developing in the Babylon React Native repository. We support development on Windows and MacOS, but assume the use of [PowerShell](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell) in the instructions below (unless otherwise noted).
38+
This quick overview will help you get started developing in the Babylon React Native repository. We support development on Windows and macOS, but assume the use of [PowerShell](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell) in the instructions below (unless otherwise noted).
3939

4040
If you are interested in making contributions, be sure to also review [CONTRIBUTING.md](CONTRIBUTING.md).
4141

4242
## Using BabylonReactNative
4343

44-
Following section will describe how to build locally a package and how to develop BabylonReactNative. If your intend is to use the plugin, follow instructions in the NPM [BabylonReadNative readme](Modules/@babylonjs/react-native/README.md).
44+
The following section will describe how to build locally a package and how to develop BabylonReactNative. If your intent is to use the plugin, follow instructions in the NPM [BabylonReactNative readme](Modules/@babylonjs/react-native/README.md).
4545

4646
### **Preparing a new Repo**
4747

@@ -53,7 +53,7 @@ Step 1 for all development environments and targets is to clone the repo. Use a
5353
git clone https://github.com/BabylonJS/BabylonReactNative
5454
```
5555

56-
Prepare BabylonNatice sources:
56+
Prepare BabylonNative sources:
5757

5858
```
5959
cd Package
@@ -71,8 +71,8 @@ npm ci
7171
This will also automatically do the following to prepare your repo for development:
7272

7373
- Update git submodules to fetch Babylon Native and its dependencies
74-
- [MacOS only] Run CMake to generate the iOS XCode project for Babylon React Native
75-
- [MacOS only] Run `pod install` to install cocoa pod depdendencies
74+
- [macOS only] Run CMake to generate the iOS Xcode project for Babylon React Native
75+
- [macOS only] Run `pod install` to install cocoa pod dependencies
7676

7777
Finally run ReactNative Test App using:
7878

@@ -127,7 +127,7 @@ With Ubuntu, you can install needed packages by this command:
127127
sudo apt-get install adb ninja-build openjdk-14-jdk android-sdk
128128
```
129129

130-
Update PATH with this commands:
130+
Update PATH with these commands:
131131

132132
```
133133
export ANDROID_HOME=$HOME/Android/Sdk
@@ -138,7 +138,7 @@ export PATH=$PATH:$ANDROID_HOME/platform-tools
138138
```
139139

140140
### **Troubleshooting**
141-
- If the Metro server is not started with `npm run android` , you can start it manually by running `npm run start` in a terminal.
141+
- If the Metro server is not started with `npm run android`, you can start it manually by running `npm run start` in a terminal.
142142
- Android Studio is the tool of choice for downloading the various versions of NDK.
143143
- If something goes wrong with the build `npm run android --verbose` can give some hints.
144144
- If the emulator is not launched by the build, you can run `~/Android/Sdk/emulator/emulator @name_of_your_image`.
@@ -175,9 +175,9 @@ When making local changes, the following manual test steps should be performed w
175175

176176
### **Building the NPM Package**
177177

178-
Every change for a Pull Request will trigger the build of the NPM package. The artifact is named `BabylonReactNative` and can be found in the Artifact section of the Corresponding GitHub Action.
178+
Every change for a Pull Request will trigger the build of the NPM package. The artifact is named `BabylonReactNative` and can be found in the Artifact section of the corresponding GitHub Action.
179179

180-
> :warning: The zip contains a Tarball GZipped `.tgz` that is automatically decompressed on MacOS. When installing that directory ( `npm install /path/to/unzipped/untared/package` ) npm creates symlinks that are not supported by the build system. Installing the .tgz instead of its decompressed version works correctly.
180+
> :warning: The zip contains a Tarball Gzipped `.tgz` that is automatically decompressed on macOS. When installing that directory ( `npm install /path/to/unzipped/untarred/package` ) npm creates symlinks that are not supported by the build system. Installing the .tgz instead of its decompressed version works correctly.
181181
182182
To get a `.tgz` that can be shared or published, follow these steps:
183183

@@ -195,21 +195,20 @@ export BABYLON_NO_CMAKE_POSTINSTALL=1
195195
npm install
196196
```
197197

198-
Build BabylonNative source tree, build Typescript copy mandatory files:
198+
Build BabylonNative source tree, build TypeScript copy mandatory files:
199199

200200
```
201201
cd Package
202202
npx gulp buildAssembled
203203
```
204204

205-
Package content is on `Package/Asssembled` folder.
205+
Package content is in `Package/Assembled` folder.
206206
Run `npm pack` to make a .tgz.
207207

208208
## Supported Versions
209209

210-
Package versions are listed on this npm.js page : [@babylonjs/react-native](https://www.npmjs.com/package/@babylonjs/react-native). Check supported Babylon.js version and corresponding BabylonNative dependency in package [README](Modules/@babylonjs/react-native/README.md)
210+
Package versions are listed on this npm.js page: [@babylonjs/react-native](https://www.npmjs.com/package/@babylonjs/react-native). Check supported Babylon.js version and corresponding BabylonNative dependency in package [README](Modules/@babylonjs/react-native/README.md)
211211

212212
## Security
213213

214-
If you believe you have found a security vulnerability in this repository, please see [SECURITY.md](SECURITY.md).
215-
214+
If you believe you have found a security vulnerability in this repository, please see [SECURITY.md](SECURITY.md).

0 commit comments

Comments
 (0)