Skip to content

Commit d6a9e85

Browse files
authored
Update README.md
Add notes for Expo beginners - Include instructions for creating a development build - Explain how to generate native Android and iOS projects - Provide best practices for version control - Add collapsible details section for better readability I hope this PR prevent these types of issues #5, #16 , #19
1 parent d1b792c commit d6a9e85

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

+28
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,34 @@ npm install expo-speech-recognition
7878
}
7979
```
8080

81+
<details>
82+
<summary>Important Note for Expo Beginners (click to expand)</summary>
83+
84+
### Important Note for Expo Beginners
85+
86+
If you've just created a new Expo project or have only been using the Expo SDK so far (without `ios/` and `android/` directories), you'll need to create a development build. Don't worry—this won't drastically change your workflow. For a better understanding of the differences between the React Native and Expo folder structures, check out this [video at the relevant timestamp](https://youtu.be/7J8LRpja9_o?t=611).
87+
88+
After completing **Step 2: Configure the config plugin**, follow these steps:
89+
90+
- To (re)-generate the native Android project, run:
91+
```bash
92+
npx expo run:android
93+
```
94+
- To (re)-generate the native iOS project, run:
95+
```bash
96+
npx expo run:ios
97+
```
98+
99+
For more details, see [Expo's prebuild documentation](https://docs.expo.dev/workflow/prebuild/#usage-with-expo-cli-run-commands).
100+
101+
### Best Practices for Version Control
102+
103+
It's recommended by the [Expo team](https://youtu.be/7J8LRpja9_o?t=611) to add the `ios/` and `android/` directories to your `.gitignore` file and rely on **Continuous Native Generation**. This approach has its own benefits, as outlined in the [Expo documentation](https://docs.expo.dev/workflow/continuous-native-generation/).
104+
105+
Now, you're ready to move on to the [Usage](#usage) section.
106+
107+
</details>
108+
81109
## Usage
82110

83111
### Using Hooks

0 commit comments

Comments
 (0)