Skip to content

Commit 2acf482

Browse files
committed
Merge pull request #52 from NativeScript/ikoevska-patch-1
Ikoevska patch 1
2 parents b96c572 + afa9338 commit 2acf482

File tree

1 file changed

+46
-28
lines changed

1 file changed

+46
-28
lines changed

resources/help.txt

Lines changed: 46 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,15 @@ Usage:
66
General commands:
77
help <command> Shows additional information about the commands in this list.
88

9-
create Creates a new NativeScript project with given project name and application identifier.
10-
platform add Creates a new platform specific project.
11-
platform list Lists all available and all installed platforms.
12-
platform remove Removes the platform specific project.
13-
prepare Copies files for specified platform, so that the project is ready to build in platform specific SDK.
9+
create Creates a new project for native development with NativeScript.
10+
platform add Configures the current project to target the selected platform.
11+
platform list Lists all platforms that the project currently targets.
12+
platform remove Removes the selected platform from the platforms that the project currently targets.
13+
This operation deletes all platform-specific files and subdirectories from your project.
14+
prepare Copies cross-platform content to the subdirectory for the selected target platform.
15+
This lets you build the project with the SDK for the selected platform and deploy it on device.
1416
build Builds the project for the selected target platform and produces an application package.
15-
run This is shorthand for prepare and build.
17+
run Runs your project on a connected device. This is shorthand for prepare, build, and deploy.
1618

1719
General options:
1820
--help Prints help about the selected command.
@@ -25,6 +27,7 @@ General options:
2527

2628
Usage:
2729
$ tns help [<Command>]
30+
2831
Lists the available commands or shows information about the selected command.
2932
<Command> is any of the available commands as listed by $ tns help.
3033

@@ -35,19 +38,21 @@ Lists the available commands or shows information about the selected command.
3538
Usage:
3639
$ tns create <App name> [--path <Directory>] [--appid <App ID>] [--copy-from <Directory>]
3740

38-
Creates a new NativeScript project.
39-
<App name> is the name of project. It should conform to platform package type limitations. For example classes in Java
40-
don't begin with numbers.
41+
Creates a new project for native development with NativeScript.
42+
<App name> is the name of project. The specified name must meet the requirements of all platforms that you want to target.
43+
For projects that target Android, you can use uppercase or lowercase letters, numbers, and underscores. The name must start with a letter.
44+
For projects that target iOS, you can use uppercase or lowercase letters, numbers, and hyphens.
4145

4246
Options:
4347
--path - Specifies the directory where you want to create the project, if different from the current directory.
4448
The directory must be empty.
45-
--appid - Sets the application identifier for your project. The application identifier must consist of at least three
46-
alphanumeric strings, separated by a dot (.). Each string must start with a letter.
47-
The application identifier corresponds to the Bundle ID for iOS apps and to the package identifier for Android apps.
49+
--appid - Sets the application identifier for your project. The application identifier must be a domain name in reverse and must
50+
meet the requirements of all platforms that you want to target.
51+
For projects that target Android, you can use uppercase or lowercase letters, numbers, and underscores in the strings of the reversed domain name, separated by a dot. Strings must be separated by a dot and must start with a letter. For example: com.nativescript.My_Andro1d_App
52+
For projects that target iOS, you can use uppercase or lowercase letters, numbers, and hyphens in the strings of the reversed domain name. Strings must be separated by a dot. For example: com.nativescript.My-i0s-App
4853
If not specified, the application identifier is set to com.telerik.<App name>.
49-
--copy-from - Specifies the directory where your javascript files are located. If not set,
50-
the default hello world template is used.
54+
--copy-from - Specifies a directory which contains custom assets that you want to use in your NativeScript project. If not set,
55+
the default hello-world template is used.
5156

5257
--[/]--
5358

@@ -56,34 +61,43 @@ Options:
5661
Usage:
5762
$ tns platform <Command>
5863

64+
You must run the platform command with a related command.
65+
5966
<Command> is a related command that extends the platform command. You can run the following related commands:
60-
list - Lists all available and installed platforms.
61-
add - Enables a project with deployment capabilities for the specified platform
62-
remove - Removes the deployment capabilities of a project for the specified platform
67+
list - Lists all platforms that the project currently targets. You can build and deploy your project only for
68+
the active target platforms.
69+
add - Configures the current project to target the selected platform. After adding the target platform, you can
70+
build and deploy your app to it.
71+
remove - Removes the selected platform from the platforms that the project currently targets. After removing
72+
the target platform, you can no longer build and deploy your app to it.
73+
This operation deletes all platform-specific files and subdirectories from your project.
6374

6475
--[/]--
6576

6677
--[platform|list]--
6778

6879
Usage:
69-
$ tns platform
80+
$ tns platform list
7081

71-
Lists all available and currently installed platforms.
82+
Lists all platforms that the project currently targets. You can build and deploy your project only for the active target platforms.
7283

7384
--[/]--
7485

7586
--[platform|add]--
7687

7788
Usage:
78-
$ tns platform add <platform>
89+
$ tns platform add <Platform>
7990

8091
Platform-specific usage:
8192
$ tns platform add android
8293
$ tns platform add ios
8394

84-
Creates a new platform specific project. The current version of the Telerik NativeScript has support for
85-
iOS and Android projects. Android projects can be created on Linux, Windows and Mac machines. iOS projects
86-
can only be created on a Mac machine.
95+
Configures the current project to target the selected platform. When you add a target platform, the Telerik NativeScript CLI adds a corresponding platform-specific subdirectory under the platforms directory. This platform-specific directory contains the necessary files to let you build your project for the target platform.
96+
97+
In this version of Telerik NativeScript, you can target iOS and Android, based on your system. You need to have your system configured for development with the target platform.
98+
On Windows systems, you can target Android.
99+
On OS X systems, you can target Android and iOS.
100+
87101

88102
--[/]--
89103

@@ -96,20 +110,23 @@ Platform-specific usage:
96110
$ tns platform remove android
97111
$ tns platform remove ios
98112

99-
Removes the deployment capabilities of a project for the specified platform.
113+
Removes the selected platform from the platforms that the project currently targets. After removing the target platform, you can no longer build and deploy your app to it.
114+
115+
This operation deletes all platform-specific files and subdirectories from your project.
100116

101117
--[/]--
102118

103119
--[prepare]--
104120

105121
Usage:
106-
$ tns prepare [<platform>]
122+
$ tns prepare [<Platform>]
107123

108124
Platform-specific usage:
109125
$ tns prepare android
110126
$ tns prepare ios
111127

112-
Copies files for specified platform, so that the project is ready to build in each SDK.
128+
Copies cross-platform content to the subdirectory for the selected target platform. This lets you build the project with
129+
the SDK for the selected platform.
113130

114131
--[/]--
115132

@@ -122,7 +139,8 @@ Platform-specific usage:
122139
$ tns build android
123140
$ tns build ios
124141

125-
Builds the project for specified platform. This generates platform-specific code within the project's platforms subdirectory.
142+
Builds the project for the selected target platform. This generates platform-specific code within the platform subdirectory
143+
in the project.
126144

127145
--[/]--
128146

@@ -135,7 +153,7 @@ Platform-specific usage:
135153
$ tns run android
136154
$ tns run ios
137155

138-
This is shorthand for prepare and build.
156+
Runs your project on a connected device. This is shorthand for prepare, build, and deploy.
139157

140158
--[/]--
141159

0 commit comments

Comments
 (0)