Skip to content
This repository was archived by the owner on Jul 10, 2024. It is now read-only.

Commit 4cccd8f

Browse files
committed
Move contributing guide to CONTRIBUTING.md
1 parent 18b96ac commit 4cccd8f

File tree

2 files changed

+40
-41
lines changed

2 files changed

+40
-41
lines changed

CONTRIBUTING.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## Contributing
2+
3+
### Set Up
4+
5+
```
6+
yarn
7+
```
8+
9+
### Build
10+
11+
```
12+
yarn build
13+
```
14+
15+
### Run Example
16+
17+
```
18+
cd example
19+
yarn
20+
```
21+
22+
Then either run on iOS:
23+
24+
```
25+
yarn ios
26+
```
27+
28+
or Android:
29+
30+
```
31+
yarn android
32+
```
33+
34+
### Update Example With NativeModule Changes
35+
36+
After making changes to the NativeModule, be sure to clean the example and reinstall dependencies:
37+
38+
```
39+
yarn reintegrate
40+
```

README.md

Lines changed: 0 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -15,44 +15,3 @@ npm install react-native-audio-engine --save
1515
## Usage
1616

1717
TODO
18-
19-
## Contributing
20-
21-
### Set Up
22-
23-
```
24-
yarn
25-
```
26-
27-
### Build
28-
29-
```
30-
yarn build
31-
```
32-
33-
### Run Example
34-
35-
```
36-
cd example
37-
yarn
38-
```
39-
40-
Then either run on iOS:
41-
42-
```
43-
yarn ios
44-
```
45-
46-
or Android:
47-
48-
```
49-
yarn android
50-
```
51-
52-
### Update Example With NativeModule Changes
53-
54-
After making changes to the NativeModule, be sure to clean the example and reinstall dependencies:
55-
56-
```
57-
yarn reintegrate
58-
```

0 commit comments

Comments
 (0)