From a32637f74b79b028d992af167265148b6d14193f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Kwa=C5=9Bniewski?= Date: Wed, 29 Nov 2023 15:08:15 +0100 Subject: [PATCH 1/4] Update README.md --- README.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d6b0de3aeba78f..61c86e3e9ebdef 100644 --- a/README.md +++ b/README.md @@ -13,12 +13,28 @@ React Native Vision OS allows you to write visionOS with full support for platfo This project is still at an early stage of development and is not ready for production use. -## Contributing +## New project creation + +1. Make sure you have a [proper development environment setup](https://reactnative.dev/docs/environment-setup) +2. Download the latest Xcode beta [here](https://developer.apple.com/xcode/). +3. Install visionOS Simulator runtime. +4. Initialize the project using this command: + +``` +npx @callstack/react-native-visionos@latest init YourApp +``` +5. Next, go to `YourApp/visionos` folder and run following commands to install Pods: -1. Download latest Xcode beta [here](https://developer.apple.com/xcode/). -2. Install visionOS Simulator runtime. -3. (Optional) Using Hermes - Install latest version of CMake (3.28) from `main` branch: -```sh -brew install cmake --HEAD ``` -4. Follow the same steps as for running iOS defined in [packages/rn-tester/README.md](./packages/rn-tester/README.md) +cd visionos +bundle install +bundle exec pod install +``` + +6. Open `YourApp/visionos/YourApp.xcworkspace` using Xcode 15 Beta. +7. Build the app by clicking the "Run" button in Xcode. + +## Contributing + +1. Follow the same steps as in the `New project creation` section. +2. Checkout `rn-tester` [packages/rn-tester/README.md](./packages/rn-tester/README.md) to build React Native from source. From 837b33bd2161608f944e6f7b860bac4fbbaefca0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Kwa=C5=9Bniewski?= Date: Wed, 29 Nov 2023 15:12:35 +0100 Subject: [PATCH 2/4] fix: update README link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 61c86e3e9ebdef..dc85024b5b32fa 100644 --- a/README.md +++ b/README.md @@ -37,4 +37,4 @@ bundle exec pod install ## Contributing 1. Follow the same steps as in the `New project creation` section. -2. Checkout `rn-tester` [packages/rn-tester/README.md](./packages/rn-tester/README.md) to build React Native from source. +2. Checkout `rn-tester` [README.md](./packages/rn-tester/README.md) to build React Native from source. From 0b3fe1130607c7e789385e799764345adb47174c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Kwa=C5=9Bniewski?= Date: Wed, 29 Nov 2023 15:13:55 +0100 Subject: [PATCH 3/4] feat: add caution section --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dc85024b5b32fa..15631c5e175d04 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,8 @@ 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. -This project is still at an early stage of development and is not ready for production use. +> [!CAUTION] +> This project is still at an early stage of development and is not ready for production use. ## New project creation From a99146ed7c0d41858b584e908ad188d0e5f8ba1a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Kwa=C5=9Bniewski?= Date: Wed, 29 Nov 2023 15:19:00 +0100 Subject: [PATCH 4/4] fix: bring back info about Hermes --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 15631c5e175d04..234397dd88d20b 100644 --- a/README.md +++ b/README.md @@ -32,8 +32,16 @@ bundle install bundle exec pod install ``` -6. Open `YourApp/visionos/YourApp.xcworkspace` using Xcode 15 Beta. -7. Build the app by clicking the "Run" button in Xcode. +6. If you want to use Hermes, you need to install CMake from source (v3.28.0) + +```sh +brew install cmake --HEAD +``` + +If not, remember to disable it in `Podfile`. + +8. Open `YourApp/visionos/YourApp.xcworkspace` using Xcode 15 Beta. +9. Build the app by clicking the "Run" button in Xcode. ## Contributing