Skip to content

Commit

Permalink
docs: improve bootstrap script and docs (#29)
Browse files Browse the repository at this point in the history
  • Loading branch information
gabimoncha authored Apr 22, 2024
1 parent a41c5d0 commit be15934
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 5 deletions.
12 changes: 11 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,22 @@ We want this community to be friendly and respectful to each other. Please follo

## Development workflow

To get started with the project, run `yarn` in the root directory to install the required dependencies for each package:
To get started with the project, run `yarn` in the `package` directory to install the required dependencies for each package:

```sh
yarn
```

## Install external headers

Make sure `skia` submodule headers are copied in the `example` directory

```sh
yarn dev:module-copy-skia-headers
```

##

> 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.
Expand Down
6 changes: 3 additions & 3 deletions package/example/ios/Podfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,7 @@ PODS:
- React
- React-callinvoker
- React-Core
- react-native-skia-skottie (2.0.3):
- react-native-skia-skottie (2.1.0):
- React
- React-Core
- react-native-skia
Expand Down Expand Up @@ -618,7 +618,7 @@ SPEC CHECKSUMS:
React-jsinspector: 8baadae51f01d867c3921213a25ab78ab4fbcd91
React-logger: 8edc785c47c8686c7962199a307015e2ce9a0e4f
react-native-skia: 60202ab85d2ea2f90f9e3d70f4dcb00fd589e72e
react-native-skia-skottie: 51211a6c49ba9a5774a75006f7c8813632dd4f2c
react-native-skia-skottie: e36c5638dfa4c142566e52a18f802803424e4d84
React-NativeModulesApple: b6868ee904013a7923128892ee4a032498a1024a
React-perflogger: 31ea61077185eb1428baf60c0db6e2886f141a5a
React-RCTActionSheet: 392090a3abc8992eb269ef0eaa561750588fc39d
Expand All @@ -643,4 +643,4 @@ SPEC CHECKSUMS:

PODFILE CHECKSUM: c7f52fd444eff4e4c78e5f161bdab7d531608ee1

COCOAPODS: 1.12.1
COCOAPODS: 1.14.3
1 change: 1 addition & 0 deletions package/example/src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -359,6 +359,7 @@ export default function App() {
const styles = StyleSheet.create({
flex1: {
flex: 1,
backgroundColor: 'white',
},
heading: {
marginTop: 16,
Expand Down
2 changes: 1 addition & 1 deletion package/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"postpack": "rm ./README.md",
"release": "release-it",
"example": "yarn --cwd example",
"bootstrap": "yarn example && yarn install && yarn example pods",
"bootstrap": "git submodule update --init --recursive && yarn example && yarn install && yarn example pods",
"clean": "del-cli android/build example/android/build example/android/app/build example/ios/build",
"dev:module-copy-skia-headers": "yarn rimraf ./cpp/skia/modules/ && mkdir -p ./cpp/modules/skottie/include && mkdir -p ./cpp/modules/skottie/src/text && cp -a ./externals/skia/modules/skottie/include/. ./cpp/modules/skottie/include && cp ./externals/skia/modules/skottie/src/text/SkottieShaper.h ./cpp/modules/skottie/src/text/SkottieShaper.h && cp ./externals/skia/modules/skottie/src/SkottieValue.h ./cpp/modules/skottie/src/SkottieValue.h",
"check-cpp": "scripts/clang-format.sh"
Expand Down

0 comments on commit be15934

Please sign in to comment.