Skip to content

Rough draft #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Rough draft #14

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
572252a
Rough draft
ikoevska Jul 29, 2014
d27bb11
Rebasing on changes from Fatme and Erjo
Aug 14, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 60 additions & 19 deletions resources/help.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,14 @@ Usage:
General commands:
help <command> Shows additional information about the commands in this list.

create Creates a new NativeScript project with given project name and application identifier.
platform add Creates a new platform specific project.
platform list Lists all available and all installed platforms.
prepare Copies files for specified platform, so that the project is ready to build in platform specific SDK.
create Creates a new project for native development with NativeScript.
platform add Configures the current project to target the selected platform.
platform list Lists all target platforms for the current project.
platform remove Removes the platform specific project.
prepare Copies cross-platform content to the subdirectory for the selected target platform.
This lets you build the project with the SDK for the selected platform.
build Builds the project for the selected target platform and produces an application package.
run This is shorthand for prepare and build.
run Runs your project on a connected device. This is shorthand for prepare, build, and deploy.

General options:
--help Prints help about the selected command.
Expand All @@ -24,6 +26,7 @@ General options:

Usage:
$ tns help [<Command>]

Lists the available commands or shows information about the selected command.
<Command> is any of the available commands as listed by $ tns help.

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

Creates a new NativeScript project.
<App name> is the name of project. It should conform to platform package type limitations. For example classes in Java
don't begin with numbers.
<App name> is the name of project. The specified name must comply with the limitations of the target platform.
For example, the name of a project that targets Android must not begin with a number because classes in Java
cannot begin with numbers.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(not a merge stopper) Maybe it is a good idea to recommend the current AppBuilder limitations to the users. They could save them some troubleshooting time, especially if they have experience with only one platform and are developing for the other.


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

--[/]--

Expand All @@ -55,44 +59,67 @@ Options:
Usage:
$ tns platform <Command>

You must run the platform command with a related command.

<Command> is a related command that extends the platform command. You can run the following related commands:
list - Lists all available and installed platforms.
add - Creates a new platform specific project
list - Lists all target platforms for the current project.
add - Configures the current project to target the selected platform.
remove - Removes the deployment capabilities of a project for the specified platform

--[/]--

--[platform|list]--

Usage:
$ tns platform
$ tns platform list

Lists all available and currently installed platforms.
Lists all target platforms for the current project.

--[/]--

--[platform|add]--

Usage:
$ tns platform add <platform>
$ tns platform add <Platform>

Platform-specific usage:
$ tns platform add android
$ tns platform add ios

Creates a new platform specific project. In this version of Telerik NativeScript you can create only ios and android projects.
You can create Android projects on windows and Mac machine. You can create ios projects only on Mac machine.
Configures the current project to target the selected platform. 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.
On Windows systems, you can target Android.
On OS X systems, you can target Android and iOS.

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.
--[/]--

--[platform|remove]--

Usage:
$ tns platform remove <platform>

Platform-specific usage:
$ tns platform remove android
$ tns platform remove ios

Removes the deployment capabilities of a project for the specified platform.

--[/]--

--[prepare]--

Usage:
$ tns prepare [<platform>]
$ tns prepare [<Platform>]

Platform-specific usage:
$ tns prepare android
$ tns prepare ios

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

--[/]--

Expand All @@ -105,7 +132,21 @@ Platform-specific usage:
$ tns build android
$ tns build ios

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

--[/]--

--[run]--

Usage:
$ tns run [<platform>]

Platform-specific usage:
$ tns run android
$ tns run ios

This is shorthand for prepare and build.

--[/]--