Skip to content

Commit 550f5a5

Browse files
committed
Update create.md
1 parent 31a235f commit 550f5a5

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

docs/man_pages/project/creation/create.md

+10-11
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,25 @@ create
33

44
Usage | Synopsis
55
---|---
6-
General | `$ tns create <App Name> [--path <Directory>] [--appid <App ID>] [--copy-from <Directory>] [--template <Template>]`
6+
Create from default JavaScript template | `$ tns create <App Name> [--path <Directory>] [--appid <App ID>]`
7+
Create from default TypeScript template | `$ tns create <App Name> [--path <Directory>] [--appid <App ID> --template typescript` OR `$ tns create <App Name> [--path <Directory>] [--appid <App ID> --template tsc`
8+
Copy from existing project | `$ tns create <App Name> [--path <Directory>] [--appid <App ID>] --copy-from <Directory>`
9+
Create from custom template | `$ tns create <App Name> [--path <Directory>] [--appid <App ID>] --template <Template>`
710

8-
Creates a new project for native development with NativeScript from the default template or from an existing NativeScript project.
11+
Creates a new project for native development with NativeScript.
912

1013
### Options
1114
* `--path` - Specifies the directory where you want to create the project, if different from the current directory. The directory must be empty.
1215
* `--appid` - Sets the application identifier for your project.
13-
* `--copy-from` - Specifies a directory which contains an existing NativeScript project. If not set, the NativeScript CLI creates the project from the default hello-world template.
14-
* `--template` - Sets the source template for the project. The value can be anything that you can `npm install` - npm package, local path, .tgz, GitHub URL. The package will be used as `app` directory of the new application.
15-
<% if(isHtml) { %>
16-
If `--template typescript` or `--template tsc` is specified, the default TypeScript template (`tns-template-hello-world-ts`) will be used.
17-
18-
In case the specified template is missing any of the `App_Resources` they will be completed in the `app` directory from the default template.
19-
<% } %>
16+
* `--copy-from` - Specifies a directory which contains an existing NativeScript project. If `--copy-from` and `--template` are not set, the NativeScript CLI creates the project from the default JavaScript hello-world template.
17+
* `--template` - Specifies a valid npm package which you want to use to create your project. If `--copy-from` and `--template` are not set, the NativeScript CLI creates the project from the default JavaScript hello-world template.<% if(isHtml) { %> If one or more application assets are missing from the `App_Resources` directory in the package, the CLI adds them using the assets available in the default hello-world template.<% } %>
2018

2119
### Attributes
2220
* `<App Name>` is the name of project. The specified name must meet the requirements of all platforms that you want to target. <% if(isConsole) { %>For more information about the `<App Name>` requirements, run `$ tns help create`<% } %><% if(isHtml) { %>For projects that target Android, you can use uppercase or lowercase letters, numbers, and underscores. The name must start with a letter.
2321
For projects that target iOS, you can use uppercase or lowercase letters, numbers, and hyphens.<% } %>
2422
* `<App ID>` is the application identifier for your project. It must be a domain name in reverse and must meet the requirements of all platforms that you want to target. If not specified, the application identifier is set to `org.nativescript.<App name>` <% if(isConsole) { %>For more information about the `<App ID>` requirements, run `$ tns help create`<% } %><% if(isHtml) { %>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`
25-
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`.<% } %>
23+
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`.
24+
* `<Template>` is a valid npm package which you want to use as template for your app. You can specify the package by name in the npm registry or by local path or GitHub URL to a directory or .tar.gz containing a package.json file. The contents of the package are be copied in the `app` directory of your project.<% } %>
2625

2726
<% if(isHtml) { %>
2827
### Related Commands
@@ -31,4 +30,4 @@ Command | Description
3130
----------|----------
3231
[init](init.html) | Initializes a project for development. The command prompts you to provide your project configuration interactively and uses the information to create a new package.json file or update the existing one.
3332
[install](/lib-management/install.html) | Installs all platforms and dependencies described in the `package.json` file in the current directory.
34-
<% } %>
33+
<% } %>

0 commit comments

Comments
 (0)