Skip to content

Commit

Permalink
Added correct example app name (#587)
Browse files Browse the repository at this point in the history
* Added correct example app name

* Removed unneeded whitespace.

---------

Co-authored-by: thePianoKid <[email protected]>
  • Loading branch information
thePianoKid and thePianoKid authored Dec 13, 2023
1 parent 2086c86 commit 70d6a5f
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,29 @@ To get started with the project, run `yarn` in the root directory to install the
```sh
yarn
```

> While it's possible to use [`npm`](https://github.com/npm/cli), the tooling is built around [`yarn`](https://classic.yarnpkg.com/), so you'll have an easier time if you use `yarn` for development.
While developing, you can run the [example app](/example/) to test your changes. Any changes you make in your library's JavaScript code will be reflected in the example app without a rebuild. If you change any native code, then you'll need to rebuild the example app.
If the installation fails with `xcrun: error: SDK "iphoneos"`, make sure [Xcode](https://apps.apple.com/us/app/xcode/id497799835?mt=12/) is installed, and the [Xcode command line tools are set correclty](https://stackoverflow.com/questions/68565356/xcrun-error-sdk-iphoneos-cannot-be-located).


While developing, you can run the [example app](/example-app/) to test your changes. Any changes you make in your library's JavaScript code will be reflected in the example app without a rebuild. If you change any native code, then you'll need to rebuild the example app.

To start the packager:

```sh
yarn example start
yarn example-app start
```

To run the example app on Android:

```sh
yarn example android
yarn example-app android
```

To run the example app on iOS:

```sh
yarn example ios
yarn example-app ios
```

Make sure your code passes TypeScript and ESLint. Run the following to verify:
Expand Down

0 comments on commit 70d6a5f

Please sign in to comment.