Skip to content

Commit 2aeff67

Browse files
committed
Update README.md (#36)
* Update README.md * fix: update README link * feat: add caution section * fix: bring back info about Hermes
1 parent e4aba88 commit 2aeff67

File tree

1 file changed

+31
-6
lines changed

1 file changed

+31
-6
lines changed

README.md

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,39 @@
1111

1212
React Native Vision OS allows you to write visionOS with full support for platform SDK. This is a full fork of the main repository with changes needed to support visionOS.
1313

14-
This project is still at an early stage of development and is not ready for production use.
14+
> [!CAUTION]
15+
> This project is still at an early stage of development and is not ready for production use.
1516
16-
## Contributing
17+
## New project creation
18+
19+
1. Make sure you have a [proper development environment setup](https://reactnative.dev/docs/environment-setup)
20+
2. Download the latest Xcode beta [here](https://developer.apple.com/xcode/).
21+
3. Install visionOS Simulator runtime.
22+
4. Initialize the project using this command:
23+
24+
```
25+
npx @callstack/react-native-visionos@latest init YourApp
26+
```
27+
5. Next, go to `YourApp/visionos` folder and run following commands to install Pods:
28+
29+
```
30+
cd visionos
31+
bundle install
32+
bundle exec pod install
33+
```
34+
35+
6. If you want to use Hermes, you need to install CMake from source (v3.28.0)
1736

18-
1. Download latest Xcode beta [here](https://developer.apple.com/xcode/).
19-
2. Install visionOS Simulator runtime.
20-
3. (Optional) Using Hermes - Install latest version of CMake (3.28) from `main` branch:
2137
```sh
2238
brew install cmake --HEAD
2339
```
24-
4. Follow the same steps as for running iOS defined in [packages/rn-tester/README.md](./packages/rn-tester/README.md)
40+
41+
If not, remember to disable it in `Podfile`.
42+
43+
8. Open `YourApp/visionos/YourApp.xcworkspace` using Xcode 15 Beta.
44+
9. Build the app by clicking the "Run" button in Xcode.
45+
46+
## Contributing
47+
48+
1. Follow the same steps as in the `New project creation` section.
49+
2. Checkout `rn-tester` [README.md](./packages/rn-tester/README.md) to build React Native from source.

0 commit comments

Comments
 (0)