Skip to content

Commit 572252a

Browse files
committed
Rough draft
1 parent 1a22a46 commit 572252a

File tree

1 file changed

+32
-19
lines changed

1 file changed

+32
-19
lines changed

resources/help.txt

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

1617
General options:
1718
--help Prints help about the selected command.
@@ -24,6 +25,7 @@ General options:
2425

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

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

3739
Creates a new NativeScript project.
38-
<App name> is the name of project. It should conform to platform package type limitations. For example classes in Java
39-
don't begin with numbers.
40+
<App name> is the name of project. The specified name must comply with the limitations of the target platform.
41+
For example, the name of a project that targets Android must not begin with a number because classes in Java
42+
cannot begin with numbers.
4043

4144
Options:
4245
--path - Specifies the directory where you want to create the project, if different from the current directory.
@@ -45,8 +48,8 @@ Options:
4548
alphanumeric strings, separated by a dot (.). Each string must start with a letter.
4649
The application identifier corresponds to the Bundle ID for iOS apps and to the package identifier for Android apps.
4750
If not specified, the application identifier is set to com.telerik.<App name>.
48-
--copy-from - Specifies the directory where your javascript files are located. If not set,
49-
the default hello world template is used.
51+
--copy-from - Specifies a directory which contains custom assets that you want to use in your NativeScript project. If not set,
52+
the default hello-world template is used.
5053

5154
--[/]--
5255

@@ -55,44 +58,53 @@ Options:
5558
Usage:
5659
$ tns platform <Command>
5760

61+
You must run the platform command with a related command.
62+
5863
<Command> is a related command that extends the platform command. You can run the following related commands:
59-
list - Lists all available and installed platforms.
60-
add - Creates a new platform specific project
64+
list - Lists all target platforms for the current project.
65+
add - Configures the current project to target the selected platform.
6166

6267
--[/]--
6368

6469
--[platform|list]--
6570

6671
Usage:
67-
$ tns platform
72+
$ tns platform list
6873

69-
Lists all available and currently installed platforms.
74+
Lists all target platforms for the current project.
7075

7176
--[/]--
7277

7378
--[platform|add]--
7479

7580
Usage:
76-
$ tns platform add <platform>
81+
$ tns platform add <Platform>
7782

7883
Platform-specific usage:
7984
$ tns platform add android
8085
$ tns platform add ios
8186

82-
Creates a new platform specific project. In this version of Telerik NativeScript you can create only ios and android projects.
83-
You can create Android projects on windows and Mac machine. You can create ios projects only on Mac machine.
87+
Configures the current project to target the selected platform. In this version of Telerik NativeScript,
88+
you can target iOS and Android, based on your system. You need to have your system configured for development with the target
89+
platform.
90+
On Windows systems, you can target Android.
91+
On OS X systems, you can target Android and iOS.
92+
93+
When you add a target platform, the Telerik NativeScript CLI adds a corresponding platform-specific subdirectory under the platforms
94+
directory. This platform-specific directory contains the necessary files to let you build your project for the target platform.
8495
--[/]--
8596

8697
--[prepare]--
8798

8899
Usage:
89-
$ tns prepare [<platform>]
100+
$ tns prepare [<Platform>]
90101

91102
Platform-specific usage:
92103
$ tns prepare android
93104
$ tns prepare ios
94105

95-
Copies files for specified platform, so that the project is ready to build in each SDK.
106+
Copies cross-platform content to the subdirectory for the selected target platform. This lets you build the project with
107+
the SDK for the selected platform.
96108

97109
--[/]--
98110

@@ -105,7 +117,8 @@ Platform-specific usage:
105117
$ tns build android
106118
$ tns build ios
107119

108-
Builds the project for specified platform. This generates platform-specific code within the project's platforms subdirectory.
120+
Builds the project for the selected target platform. This generates platform-specific code within the platforms subdirectory
121+
in the project.
109122

110123
--[/]--
111124

0 commit comments

Comments
 (0)