Skip to content

Commit 18e3a10

Browse files
author
Chris Brody
authored
example app doc updates (quick updates) (#260)
1 parent 96ed1eb commit 18e3a10

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -171,12 +171,16 @@ cd react-native-alice-helper/example
171171

172172
#### Running the example app
173173

174-
__Within the example test app subdirectory:__
174+
**Recommended:** Follow the instructions shown in the end of the console log output, which are more likely to be up-to-date.
175+
176+
__Extra notes:__
177+
178+
_Within the example test app subdirectory:_
175179

176180
It is *recommended* to start the Metro Bundler manually (within `react-native-alice-helper/example`), which would run in the foreground:
177181

178182
```
179-
npm start
183+
yarn start
180184
```
181185

182186
Otherwise, React Native will open its own window to run the Metro Bundler.
@@ -195,7 +199,7 @@ ANDROID_HOME=~/Library/Android/sdk react-native run-android
195199

196200
For iOS:
197201

198-
Extra installation step needed on React Native 0.60(+) (see [issue #28](https://github.com/brodybits/create-react-native-module/issues/28)):
202+
Extra installation step needed _in case of clean checkout only_:
199203

200204
```
201205
cd ios && pod install && cd ..
@@ -213,7 +217,7 @@ or do the following command to open the iOS project in Xcode:
213217
open ios/example.xcodeproj
214218
```
215219

216-
__Expected result:__
220+
#### Expected result
217221

218222
The example app shows the following indications:
219223

@@ -238,17 +242,26 @@ Then go into the example app subdirectory:
238242
cd react-native-carol-widget/example
239243
```
240244

241-
__Within the example test app subdirectory:__
245+
#### Running the view example app
246+
247+
**Recommended:** Follow the instructions shown in the end of the console log output, which are more likely to be up-to-date.
248+
249+
__Some extra notes:__
250+
251+
_Within the example test app subdirectory:_
242252

243253
It is *recommended* to start the Metro Bundler manually as described above (within `react-native-carol-widget/example`):
244254

245255
```
246-
npm start
256+
yarn start
247257
```
248258

249259
To run on Android: do `react-native run-android` as described for the other example above.
250260

251-
To run on iOS: do `pod install` in `ios` subdirectory for React Native 0.60(+) (see above), then do `react-native run-ios` or `open ios/example.xcodeproj` as described for the other example above.
261+
To run on iOS (as described above):
262+
263+
- _in case of clean checkout **only**_: do `pod install` in `ios` subdirectory
264+
- do `react-native run-ios` or `open ios/example.xcodeproj`
252265

253266
__Expected result:__
254267

0 commit comments

Comments
 (0)