Skip to content

Commit a8fbb3e

Browse files
author
Iva Koevska
committed
Merge branch 'patch-1' of https://github.com/ikoevska/nativescript-cli into ikoevska-patch-1
Conflicts: resources/help.txt
2 parents 8eb0a7d + 572252a commit a8fbb3e

File tree

1 file changed

+31
-20
lines changed

1 file changed

+31
-20
lines changed

resources/help.txt

Lines changed: 31 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@ 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.
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 target platforms for the current project.
1212
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.
13+
prepare Copies cross-platform content to the subdirectory for the selected target platform.
14+
This lets you build the project with the SDK for the selected platform.
1415
build Builds the project for the selected target platform and produces an application package.
15-
run This is shorthand for prepare and build.
16+
run Runs your project on a connected device. This is shorthand for prepare, build, and deploy.
1617

1718
General options:
1819
--help Prints help about the selected command.
@@ -25,6 +26,7 @@ General options:
2526

2627
Usage:
2728
$ tns help [<Command>]
29+
2830
Lists the available commands or shows information about the selected command.
2931
<Command> is any of the available commands as listed by $ tns help.
3032

@@ -36,8 +38,9 @@ Usage:
3638
$ tns create <App name> [--path <Directory>] [--appid <App ID>] [--copy-from <Directory>]
3739

3840
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+
<App name> is the name of project. The specified name must comply with the limitations of the target platform.
42+
For example, the name of a project that targets Android must not begin with a number because classes in Java
43+
cannot begin with numbers.
4144

4245
Options:
4346
--path - Specifies the directory where you want to create the project, if different from the current directory.
@@ -46,8 +49,8 @@ Options:
4649
alphanumeric strings, separated by a dot (.). Each string must start with a letter.
4750
The application identifier corresponds to the Bundle ID for iOS apps and to the package identifier for Android apps.
4851
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.
52+
--copy-from - Specifies a directory which contains custom assets that you want to use in your NativeScript project. If not set,
53+
the default hello-world template is used.
5154

5255
--[/]--
5356

@@ -56,35 +59,41 @@ Options:
5659
Usage:
5760
$ tns platform <Command>
5861

62+
You must run the platform command with a related command.
63+
5964
<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
65+
list - Lists all target platforms for the current project.
66+
add - Configures the current project to target the selected platform.
6267
remove - Removes the deployment capabilities of a project for the specified platform
6368

6469
--[/]--
6570

6671
--[platform|list]--
6772

6873
Usage:
69-
$ tns platform
74+
$ tns platform list
7075

71-
Lists all available and currently installed platforms.
76+
Lists all target platforms for the current project.
7277

7378
--[/]--
7479

7580
--[platform|add]--
7681

7782
Usage:
78-
$ tns platform add <platform>
83+
$ tns platform add <Platform>
7984

8085
Platform-specific usage:
8186
$ tns platform add android
8287
$ tns platform add ios
8388

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.
89+
Configures the current project to target the selected platform. In this version of Telerik NativeScript,
90+
you can target iOS and Android, based on your system. You need to have your system configured for development with the target
91+
platform.
92+
On Windows systems, you can target Android.
93+
On OS X systems, you can target Android and iOS.
8794

95+
When you add a target platform, the Telerik NativeScript CLI adds a corresponding platform-specific subdirectory under the platforms
96+
directory. This platform-specific directory contains the necessary files to let you build your project for the target platform.
8897
--[/]--
8998

9099
--[platform|remove]--
@@ -103,13 +112,14 @@ Removes the deployment capabilities of a project for the specified platform.
103112
--[prepare]--
104113

105114
Usage:
106-
$ tns prepare [<platform>]
115+
$ tns prepare [<Platform>]
107116

108117
Platform-specific usage:
109118
$ tns prepare android
110119
$ tns prepare ios
111120

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

114124
--[/]--
115125

@@ -122,7 +132,8 @@ Platform-specific usage:
122132
$ tns build android
123133
$ tns build ios
124134

125-
Builds the project for specified platform. This generates platform-specific code within the project's platforms subdirectory.
135+
Builds the project for the selected target platform. This generates platform-specific code within the platforms subdirectory
136+
in the project.
126137

127138
--[/]--
128139

0 commit comments

Comments
 (0)