Skip to content

Commit c3c594b

Browse files
Merge pull request #3427 from NativeScript/kerezov/run-help
docs: document run platform
2 parents 69bc287 + 73b8814 commit c3c594b

File tree

3 files changed

+9
-2
lines changed

3 files changed

+9
-2
lines changed

docs/man_pages/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,13 @@ Command | Description
3030
[init](project/creation/init.html) | Initializes an existing project for native development with NativeScript.
3131
[platform add `<Platform>`](project/configuration/platform-add.html) | Configures the current project to target the selected platform.
3232
[platform list](project/configuration/platform.html) | Lists all platforms that the project currently targets.
33-
[platform&nbsp;remove&nbsp;`<Platform>`](project/configuration/platform-remove.html) | Removes the selected platform from the platforms that the project currently targets. This operation deletes all platform-specific files and subdirectories from your project.
33+
[platform remove `<Platform>`](project/configuration/platform-remove.html) | Removes the selected platform from the platforms that the project currently targets. This operation deletes all platform-specific files and subdirectories from your project.
3434
[platform update `<Platform>`](project/configuration/platform-update.html) | Updates the NativeScript runtime for the specified platform.
3535
[prepare `<Platform>`](project/configuration/prepare.html) | Copies relevant content from the app directory to the subdirectory for the selected target platform to let you build the project.
3636
[build `<Platform>`](project/testing/build.html) | Builds the project for the selected target platform and produces an application package or an emulator package.
3737
[deploy `<Platform>`](project/testing/deploy.html) | Deploys the project to a connected physical or virtual device.
3838
[run](project/testing/run.html) | Runs your project on a connected device or in the native emulator, if configured.
39+
[run `<Platform>`](project/testing/run.html) | Runs your project on a connected device or in the native emulator for the specified platform, if configured.
3940
[debug `<Platform>`](project/testing/debug.html) | Debugs your project on a connected physical or virtual device.
4041
[test init](project/testing/test-init.html) | Configures your project for unit testing with a selected framework.
4142
[test `<Platform>`](project/testing/test.html) | Runs the unit tests in your project on a connected physical or virtual device.

docs/man_pages/project/configuration/prepare.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ in the `platforms` directory. This lets you build the project with the SDK for t
1818
* `android` - Prepares your project for an Android build.
1919
* `ios` - Prepares your project for an iOS build.<% } %>
2020

21-
<% if(isHtml) { %>
21+
<% if(isHtml) { %>
2222
### Command Limitations
2323

2424
* You can run `$ tns prepare ios` only on OS X systems.

docs/man_pages/project/testing/run.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Usage | Synopsis
99
---|---
1010
Run on all connected devices | `$ tns run [--release] [--justlaunch]`
1111
Run on a selected connected device or running emulator. Will start emulator with specified `Device Identifier`, if not already running. | `$ tns run --device <Device ID> [--release] [--justlaunch]`
12+
<% if((isConsole && isMacOS) || isHtml) { %>Run on all connected devices of the speficied `Platform` | `$ tns run <Platform> [--release] [--justlaunch]`<% } %>
1213

1314
Runs your project on all connected devices or in native emulators for the selected platform.<% if(isConsole && (isLinux || isWindows)) { %>The command will work with all currently running Android devices and emulators.<% } %> The command will prepare, build and deploy the app when necessary. By default listens for changes in your code, synchronizes those changes and refreshes all selected devices.
1415

@@ -19,6 +20,11 @@ Runs your project on all connected devices or in native emulators for the select
1920

2021
### Attributes
2122
* `<Device ID>` is the index or `Device Identifier` of the target device as listed by `$ tns device <Platform> --available-devices`
23+
<% if((isConsole && isMacOS) || isHtml) { %>
24+
* `<Platform>` is the target mobile platform for which you want to run your project. You can set the following target platforms.
25+
* `android` - Run your project on all Android devices and emulators.
26+
* `ios` - Run your project on all iOS devices and simulators.
27+
<% } %>
2228

2329
<% if(isHtml) { %>
2430
### Command Limitations

0 commit comments

Comments
 (0)