Skip to content

Commit c42e9e6

Browse files
author
Iva Koevska
committed
Refining existing texts
Adding Run section to indicate that the run command exists
1 parent 8da6286 commit c42e9e6

File tree

1 file changed

+27
-14
lines changed

1 file changed

+27
-14
lines changed

README.md

Lines changed: 27 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ The Telerik NativeScript CLI lets you create, build, and deploy NativeScript-bas
1919
* [Build Your Project](#build-your-project)
2020
* [Deploy Your Project](#deploy-your-project)
2121
* [Emulate Your Project](#emulate-your-project)
22-
* [Known Issues](#troubleshooting)
22+
* [Run Your Project](#run-your-project)
23+
* [Known Issues](#known-issues)
2324
* [How to Contribute](#how-to-contribute)
2425
* [License](#license)
2526

@@ -80,10 +81,7 @@ Path to tools directory in the Android SDK installation folder
8081
Path to platform-tools directory in the Android SDK installation folder
8182
```
8283

83-
For example:
84-
```
85-
PATH=...;...;C:\tools\apache-ant-1.9.4\bin;%localappdata%\Android\android-sdk\tools;%localappdata%\Android\android-sdk\platform-tools;
86-
```
84+
For example: PATH=...;...;C:\tools\apache-ant-1.9.4\bin;%localappdata%\Android\android-sdk\tools;%localappdata%\Android\android-sdk\platform-tools;
8785

8886
If you have installed Chocolatey, you can complete these steps to set up JDK, Apache Ant, and Android SDK.
8987

@@ -188,21 +186,22 @@ Quick Start
188186
* [Build Your Project](#build-your-project)
189187
* [Deploy Your Project](#deploy-your-project)
190188
* [Emulate Your Project](#emulate-your-project)
189+
* [Run Your Project](#run-your-project)
191190

192191
## The Commands
193192

194193
Run `tns help` to list all available commands. Run or `tns <Command> --help` to view more information about a selected command.
195194

196195
* `help` lists all available commands.
197-
* `create <App name> [--path <Directory>] [--appid <App ID>] [--copy-from <Directory>]` creates a new project with the specified settings.
196+
* `create <App Name> [--path <Directory>] [--appid <App ID>] [--copy-from <Directory>]` creates a new project with the specified settings.
198197
* `platform list` lists the current target platforms for your project.
199198
* `platform add <Platform>` adds a new target platform to your project.
200199
* `platform remove <Platform>` removes the selected platform from the target platforms of the project.
201200
* `prepare <Platform>` copies cross-platform and selected platform-specific content to the subdirectory for the target platform.
202201
* `build <Platform>` builds the project for the selected target platform.
203202
* `emulate <Platform>` builds the project for the selected target platform and runs it in the native emulator, if configured.
204203
* `deploy <Platform> [--device <Device ID>]` deploys an already built application on connected device.
205-
* `run <Platform>` executes `prepare`, `build`, and `deploy`.
204+
* `run <Platform> [--device <Device ID>]` executes `prepare`, `build`, and `deploy`.
206205
* `list-devices` lists connected devices, including any running Android Virtual Devices.
207206
* `feature-usage-tracking` configures anonymous feature usage tracking.
208207

@@ -250,7 +249,7 @@ MyApp/
250249
`-- .tnsproject
251250
```
252251

253-
* The `app` directory is the development space for your application. You should modify all common and platform-specific code within this directory. When you run `prepare <Platform>`, the Telerik NativeScript CLI copies relevant content to the platform-specific folders for each target platform.
252+
* The `app` directory is the **development space for your application**. You should modify all common and platform-specific code within this directory. When you run `prepare <Platform>`, the Telerik NativeScript CLI copies relevant content to the platform-specific folders for each target platform.
254253
* The `hooks` directory is an empty directory. In a future release of the Telerik NativeScript CLI, in `hooks`, you will be able to store scripts that are automatically executed before and after a specified command.
255254
* The `platforms` directory is created empty. When you add a target platform to your project, the Telerik NativeScript CLI creates a new subdirectory with the platform name. The subdirectory contains the ready-to-build resources of your app. When you run `prepare <Platform>`, the Telerik NativeScript CLI copies relevant content from the `app` directory to the platform-specific subdirectory for each target platform.<br/>In the `platforms` directory, you can safely modify configuration files such as `AndroidManifest.xml` and `Info.plist`.
256255
* The `tns_modules` is an empty directory. In a future release of the Telerik NativeScript CLI, in `tns_modules`, you will be able to add custom Telerik NativeScript modules to extend the functionality of the basic framework.
@@ -295,6 +294,7 @@ platforms/
295294
```
296295

297296
For more information about the structure of Android native projects, see [Android Projects](http://developer.android.com/tools/projects/index.html#ApplicationProjects).
297+
298298
For more information about the structure iOS native projects, see [Code Organization in Xcode Projects](http://akosma.com/2009/07/28/code-organization-in-xcode-projects/).
299299

300300
[Back to Top][1]
@@ -316,7 +316,7 @@ For more information about working with Telerik NativeScript, see the following
316316

317317
### Development in `app`
318318

319-
The `app` directory in the root of the project is the development space for your project. Place all your common and platform-specific code in this directory. When you run `prepare <Platform>`, the Telerik NativeScript CLI copies relevant content to the platform-specific folders for each target platform.
319+
The `app` directory in the root of the project is the development space for your project. **Place all your common and platform-specific code in this directory.** When you run `prepare <Platform>`, the Telerik NativeScript CLI copies relevant content to the platform-specific folders for each target platform.
320320

321321
In the `app` directory, you can use **platform-specific files** to provide customized functionality and design for each target platform. To indicate that a file is platform-specific, make sure that the file name is in the following format: `name.ios.extension` or `name.android.extension`. For example: `main.ios.js` or `main.android.js`.
322322

@@ -326,7 +326,7 @@ You can develop shared functionality or design in common files. To indicate that
326326

327327
In `platforms`, you can safely modify files which are part of the native project structure and do not have a corresponding source located in the `app` directory in the root. For example, `AndroidManifest.xml` and `Info.plist`.
328328

329-
Do not modify files and resources that have a corresponding file in the `app` directory in the root, such as application scripts, icons, and splash screens. The Telerik NativeScript CLI overrides such files during the `prepare <Platform>` operation with the content from `app`.
329+
**Do not modify files and resources that have a corresponding file in the `app` directory in the root**, such as application scripts, icons, and splash screens. The Telerik NativeScript CLI overrides such files during the `prepare <Platform>` operation with the content from `app`.
330330

331331
### Development in `hooks`
332332

@@ -351,7 +351,7 @@ tns prepare ios
351351

352352
Keep in mind that `prepare` overrides changes made to the platform-specific subdirectory in `platforms`. For more information, see [Development in platforms](#development-in-platforms).
353353

354-
> **IMPORTANT:** Always run `prepare <Platform>` before running `build <Platform>` or `deploy <Platform>`. This ensures that the Telerik NativeScript CLI will build an application package with your latest code and resources.
354+
> **IMPORTANT:** Always run `prepare <Platform>` before running `build <Platform>`, `deploy <Platform>`, or `emulate <Platform>`. This ensures that the Telerik NativeScript CLI will build an application package with your latest code and resources.
355355
356356
[Back to Top][1]
357357

@@ -366,9 +366,9 @@ tns build ios
366366

367367
The Telerik NativeScript CLI calls the SDK for the selected target platform and uses it to build your app locally.
368368

369-
When you build for Android, the Telerik NativeScript CLI saves the application package as an `APK` in `platforms` -> `android` -> `bin`.
369+
When you build for Android, the Telerik NativeScript CLI saves the application package as an `APK` in `platforms` &#8594; `android` &#8594; `bin`.
370370

371-
When you build for iOS, the Telerik NativeScript CLI saves the application package as an `IPA` in `platforms` -> `ios` -> `build` -> `device`.
371+
When you build for iOS, the Telerik NativeScript CLI saves the application package as an `IPA` in `platforms` &#8594; `ios` &#8594; `build` &#8594; `device`.
372372

373373
> **IMPORTANT:** To build your app for iOS, you need to configure a valid pair of certificate and provisioning profile for code signing your application package. For more information, see [iOS Code Signing - A Complete Walkthrough](http://seventhsoulmountain.blogspot.com/2013/09/ios-code-sign-in-complete-walkthrough.html).
374374
@@ -409,14 +409,27 @@ tns emulate android
409409
tns emulate ios
410410
```
411411

412-
This operation launches the native device emulator for the selected target platform and runs your project in the virtual device.
412+
This operation calls the SDK for the selected target platform, builds your app locally, launches the native device emulator for the selected target platform, and runs your project on the virtual device.
413413

414414
For Android, the Telerik NativeScript CLI runs your app in the earliest created virtual device or the currently running Android Virtual Device. Before running your app in the Android native emulator, make sure that you have configured at least one virtual device in the Android Virtual Device manager.
415415

416416
For iOS, the Telerik NativeScript CLI runs your app in the iOS Simulator.
417417

418418
[Back to Top][1]
419419

420+
## Run Your Project
421+
422+
You can quickly run your app on connected devices, including running Android Virtual Devices.
423+
424+
```Shell
425+
tns run android
426+
tns run ios
427+
```
428+
429+
This operation runs `prepare`, `build`, and `deploy`.
430+
431+
[Back to Top][1]
432+
420433
Known Issues
421434
===
422435

0 commit comments

Comments
 (0)