You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-6Lines changed: 15 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,22 +34,31 @@ For more information on each directory, click the link and read the directory's
34
34
35
35
## Requirements
36
36
37
-
Node 8 or greater is required. Development for iOS requires Xcode 9 or up and will target iOS 9 and up.
37
+
Node 8 or greater is required. Development for iOS requires a Mac and Xcode 9 or up, and will target iOS 9 and up.
38
38
39
-
## Installation
40
-
41
-
First install all the dependencies required by React Native:
39
+
You also need to install the dependencies required by React Native:
42
40
43
41
- for [Android development](https://facebook.github.io/react-native/docs/getting-started.html#installing-dependencies-3)
44
42
- for [iOS development](https://facebook.github.io/react-native/docs/getting-started.html#installing-dependencies)
45
43
46
-
Then:
44
+
## Usage
45
+
46
+
To create a new project using the boilerplate:
47
47
48
48
- clone this repository
49
49
- remove the previous git history: `rm -rf .git/`
50
50
- rename the React Native project to your own project name: `npm run rename -- <YourProjectName>` (the default name is `Boilerplate`)
51
+
- remove the LICENSE file and the License section from the README if your project is not open source
52
+
53
+
Feel free to remove this section from the README as you will no longer need it in your project. You are encouraged to keep the rest of the documentation in your project so that it is self-explanatory.
54
+
55
+
## Running the project
56
+
57
+
Assuming you have all the requirements installed, you can setup and run the project by running:
51
58
52
-
You can now start the application, for example with `react-native run-android`.
59
+
-`yarn install` to install the dependencies
60
+
-`react-native run-android` to run the Android application (remember to start a simulator or connect an Android phone)
61
+
-`react-native run-ios` to run the iOS application (remember to start a simulator or connect an iPhone phone)
0 commit comments