Skip to content

Commit d1009ac

Browse files
author
Matthieu Napoli
committed
Improve the documentation to install the boilerplate and the project
1 parent 0ea4cda commit d1009ac

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,22 +34,31 @@ For more information on each directory, click the link and read the directory's
3434

3535
## Requirements
3636

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.
3838

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:
4240

4341
- for [Android development](https://facebook.github.io/react-native/docs/getting-started.html#installing-dependencies-3)
4442
- for [iOS development](https://facebook.github.io/react-native/docs/getting-started.html#installing-dependencies)
4543

46-
Then:
44+
## Usage
45+
46+
To create a new project using the boilerplate:
4747

4848
- clone this repository
4949
- remove the previous git history: `rm -rf .git/`
5050
- 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:
5158

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)
5362

5463
## License
5564

0 commit comments

Comments
 (0)