Skip to content
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

fix(🔗): remove deadlink in the documentation #2939

Merged
merged 2 commits into from
Feb 5, 2025
Merged

fix(🔗): remove deadlink in the documentation #2939

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
906eba5
fix(🔗): remove deadlink in the documentation
wcandillon Feb 5, 2025
105caf8
Merge branch 'main' into wcandillon-patch-70
wcandillon Feb 5, 2025
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
16 changes: 5 additions & 11 deletions apps/docs/docs/getting-started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,17 +84,6 @@ Not all features have been tested yet, so please [report](https://github.com/Sho

:::

## Playground

We have an example project you can play with [here](https://github.com/Shopify/react-native-skia/tree/main/example).

```sh
yarn bootstrap
cd example && yarn start
```

To run the example project on iOS, you will need to run `pod install`, and on Android, you will also need Android NDK to be installed ([see here](#android)).

## Debugging

We recommend using React Native DevTools to debug your JS code — see the [React Native docs](https://reactnative.dev/docs/debugging). Alternatively, you can debug both JS and platform code in VS Code and via native IDEs. If using VS Code, we recommend [Expo Tools](https://github.com/expo/vscode-expo), [Radon IDE](https://ide.swmansion.com/), or Microsoft's [React Native Tools](https://marketplace.visualstudio.com/items?itemName=msjsdiag.vscode-react-native#debugging-react-native-applications).
Expand Down Expand Up @@ -158,3 +147,8 @@ afterEach(cleanup);
```

With this configuration, you will have properly set up Jest to work with React Native Skia mocks using either ECMAScript Modules or CommonJS.

## Playground

We have example projects you can play with [here](https://github.com/Shopify/react-native-skia/tree/main/apps).
It would require you first to [build Skia locally](https://github.com/shopify/react-native-skia?tab=readme-ov-file#library-development) first.
Loading