Skip to content

Update README.md #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 29, 2023
Merged

Update README.md #36

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a32637f
Update README.md
okwasniewski Nov 29, 2023
837b33b
fix: update README link
okwasniewski Nov 29, 2023
0b3fe11
feat: add caution section
okwasniewski Nov 29, 2023
a99146e
fix: bring back info about Hermes
okwasniewski Nov 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 31 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,39 @@

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.

## 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:

```
cd visionos
bundle install
bundle exec pod install
```

6. If you want to use Hermes, you need to install CMake from source (v3.28.0)

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)

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

1. Follow the same steps as in the `New project creation` section.
2. Checkout `rn-tester` [README.md](./packages/rn-tester/README.md) to build React Native from source.