Skip to content

Commit d127421

Browse files
Merge pull request #2206 from NativeScript/vladimirov/sys-reqs
Update README
2 parents 00ef59e + ed2509c commit d127421

File tree

1 file changed

+79
-59
lines changed

1 file changed

+79
-59
lines changed

README.md

Lines changed: 79 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,18 @@ The NativeScript CLI lets you create, build, and deploy NativeScript-based proje
1111
* [Supported Platforms](#supported-platforms "The mobile platforms you can target with NativeScript")
1212
* [System Requirements](#system-requirements "The hardware and software requirements for setting up and working with the NativeScript CLI")
1313
* [Installation](#installation "How to configure and install the NativeScript CLI")
14-
* [Install the NativeScript CLI](#install-the-nativescript-cli)
15-
* [Configure Proxy Usage](#configure-proxy-usage)
14+
* [Install the NativeScript CLI](#install-the-nativescript-cli)
15+
* [Configure Proxy Usage](#configure-proxy-usage)
1616
* [Quick Start](#quick-start "Get started with the NativeScript CLI")
17-
* [The Commands](#the-commands)
18-
* [Create Project](#create-project)
19-
* [Add Platforms](#add-platforms)
20-
* [Develop Your Project](#develop-your-project)
21-
* [Prepare for Build](#prepare-for-build)
22-
* [Build Your Project](#build-your-project)
23-
* [Deploy Your Project](#deploy-your-project)
24-
* [Emulate Your Project](#emulate-your-project)
25-
* [Run Your Project](#run-your-project)
17+
* [The Commands](#the-commands)
18+
* [Create Project](#create-project)
19+
* [Add Platforms](#add-platforms)
20+
* [Develop Your Project](#develop-your-project)
21+
* [Prepare for Build](#prepare-for-build)
22+
* [Build Your Project](#build-your-project)
23+
* [Deploy Your Project](#deploy-your-project)
24+
* [Emulate Your Project](#emulate-your-project)
25+
* [Run Your Project](#run-your-project)
2626
* [Extending the CLI](#extending-the-cli)
2727
* [Troubleshooting](#troubleshooting)
2828
* [Known Issues](#known-issues)
@@ -87,7 +87,7 @@ start-process -FilePath PowerShell.exe -Verb Runas -Wait -ArgumentList "-NoProfi
8787
### Manual Setup
8888

8989
* Windows 7 SP1 or later
90-
* The latest Node.js [0.10.x](https://nodejs.org/dist/latest-v0.10.x/), [0.12.x](https://nodejs.org/dist/latest-v0.12.x/), [4.x](https://nodejs.org/dist/latest-v4.x/) or [5.x](https://nodejs.org/dist/latest-v5.x/) stable official release
90+
* The latest Node.js [4.x](https://nodejs.org/dist/latest-v4.x/), [6.x](https://nodejs.org/dist/latest-v6.x/) or [7.x](https://nodejs.org/dist/latest-v7.x/) stable official release
9191
* (Optional) [Chocolatey][Chocolatey]
9292
* [JDK 8][JDK 8] or a later stable official release
9393
* [Android SDK 22][Android SDK 22] or a later stable official release
@@ -100,35 +100,35 @@ If you have installed Chocolatey, you can complete these steps to set up JDK, an
100100
1. Run a Windows command prompt.
101101
1. To install JDK, run the following command.
102102

103-
```Shell
104-
choco install java.jdk
105-
```
103+
```Shell
104+
choco install java.jdk
105+
```
106106
1. If not present, create the following environment variables.
107107

108-
```
109-
JAVA_HOME=Path to the jdk* install directory
110-
```
108+
```
109+
JAVA_HOME=Path to the jdk* install directory
110+
```
111111

112-
For example: JAVA_HOME=C:\Program Files\Java\jdk1.8.0_66
112+
For example: JAVA_HOME=C:\Program Files\Java\jdk1.8.0_66
113113

114-
```
115-
ANDROID_HOME=Path to Android installation directory
116-
```
114+
```
115+
ANDROID_HOME=Path to Android installation directory
116+
```
117117

118-
For example: ANDROID_HOME=C:\Android\android-sdk
118+
For example: ANDROID_HOME=C:\Android\android-sdk
119119

120120
> NOTE: This is the directory that contains `tools` and `platform-tools` directories.
121121

122122
1. To install the Android SDK, run the following command.
123123

124-
```Shell
125-
choco install android-sdk
126-
```
124+
```Shell
125+
choco install android-sdk
126+
```
127127
1. To update the Android SDK to 22 or later, run the following command.
128128

129-
```Shell
130-
android update sdk
131-
```
129+
```Shell
130+
android update sdk
131+
```
132132
1. Select all packages for the Android 22 SDK and any other SDKs that you want to install, click **Install** and wait for the installation to complete.
133133
1. Select Android SDK Build-tools 22.0.0 or later stable version, click **Install** and wait for the installation to complete.
134134
1. Select Extras/Android Support Repository, click **Install** and wait for the installation to complete.
@@ -151,19 +151,19 @@ sudo ruby -e "$(curl -fsSL https://www.nativescript.org/setup/mac)"
151151
### Manual Setup
152152

153153
* OS X Mavericks
154-
* The latest Node.js [0.10.x](https://nodejs.org/dist/latest-v0.10.x/), [0.12.x](https://nodejs.org/dist/latest-v0.12.x/), [4.x](https://nodejs.org/dist/latest-v4.x/) or [5.x](https://nodejs.org/dist/latest-v5.x/) stable official release
154+
* The latest Node.js [4.x](https://nodejs.org/dist/latest-v4.x/), [6.x](https://nodejs.org/dist/latest-v6.x/) or [7.x](https://nodejs.org/dist/latest-v7.x/) stable official release
155155
* For iOS development
156-
* [Latest Xcode][12]
157-
* [Xcode command-line tools][12]
158-
* [xcodeproj ruby gem][13] - can be installed by running `$ [sudo] gem install xcodeproj` in the terminal
159-
* (Optional) [CocoaPods][CocoaPods]
160-
* (Optional) [xcproj][xcproj] - you only need this command line tool in case you have Xcode 7.3 or later installed and CocoaPods 0.39.0 or earlier. `xcproj` can either be installed by running `$ brew install xcproj` in the terminal, or by building it manually with xcodebuild
156+
* [Latest Xcode][12]
157+
* [Xcode command-line tools][12]
158+
* [xcodeproj ruby gem][13] - can be installed by running `$ [sudo] gem install xcodeproj` in the terminal
159+
* (Optional) [CocoaPods][CocoaPods]
160+
* (Optional) [xcproj][xcproj] - you only need this command line tool in case you have Xcode 7.3 or later installed and CocoaPods 0.39.0 or earlier. `xcproj` can either be installed by running `$ brew install xcproj` in the terminal, or by building it manually with xcodebuild
161161
* For Android development
162-
* [JDK 8][JDK 8] or a later stable official release
163-
* [Android SDK 22][Android SDK 22] or a later stable official release
164-
* [Android SDK Build-tools 23.0.0][Android SDK Build-tools 23.0.0] or a later stable official release
165-
* [Android Support Repository][Android Support Repository]
166-
* (Optional) [Genymotion][Genymotion]
162+
* [JDK 8][JDK 8] or a later stable official release
163+
* [Android SDK 22][Android SDK 22] or a later stable official release
164+
* [Android SDK Build-tools 23.0.0][Android SDK Build-tools 23.0.0] or a later stable official release
165+
* [Android Support Repository][Android Support Repository]
166+
* (Optional) [Genymotion][Genymotion]
167167

168168
If not present, create the following environment variables.
169169

@@ -192,21 +192,21 @@ echo yes | android update sdk --filter tools,platform-tools,android-23,build-too
192192
> On Linux systems, you can develop, build, and deploy NativeScript projects that target Android.
193193

194194
* Ubuntu 14.04 LTS
195-
* The latest Node.js [0.10.x](https://nodejs.org/dist/latest-v0.10.x/), [0.12.x](https://nodejs.org/dist/latest-v0.12.x/), [4.x](https://nodejs.org/dist/latest-v4.x/) or [5.x](https://nodejs.org/dist/latest-v5.x/) stable official release
195+
* The latest Node.js [4.x](https://nodejs.org/dist/latest-v4.x/), [6.x](https://nodejs.org/dist/latest-v6.x/) or [7.x](https://nodejs.org/dist/latest-v7.x/) stable official release
196196

197-
> **TIP:** You can follow the instructions provided [here](https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager) to install Node.js on your system.
197+
> **TIP:** You can follow the instructions provided [here](https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager) to install Node.js on your system.
198198

199199
* G++ compiler
200200

201-
```Shell
202-
sudo apt-get install g++
201+
```Shell
202+
sudo apt-get install g++
203203
```
204204
* On 64-bit systems only
205-
* The runtime libraries for the ia32/i386 architecture.
205+
* The runtime libraries for the ia32/i386 architecture.
206206

207-
```Shell
208-
sudo apt-get install lib32z1 lib32ncurses5 lib32bz2-1.0 libstdc++6:i386
209-
```
207+
```Shell
208+
sudo apt-get install lib32z1 lib32ncurses5 lib32bz2-1.0 libstdc++6:i386
209+
```
210210
* [JDK 8][JDK 8] or a later stable official release
211211
* [Android SDK 22][Android SDK 22] or a later stable official release
212212
* [Android SDK Build-tools 23.0.0][Android SDK Build-tools 23.0.0] or a later stable official release
@@ -290,7 +290,7 @@ Quick Start
290290
Run `tns help` to view all available commands in the browser. Run `tns help <Command>` to view more information about a selected command in the browser.
291291

292292
* `help` opens a new browser window and lists all available commands.
293-
* `create <App Name> [--path <Directory>] [--appid <App ID>] [--copy-from <Directory>]` creates a new project with the specified settings.
293+
* `create <App Name> [--path <Directory>] [--appid <App ID>] [--copy-from <Directory>] [--template <Valid template>] [--ng] [--tsc]` creates a new project with the specified settings.
294294
* `init` initializes an existing project and prompts for project configuration.
295295
* `platform list` lists the current target platforms for your project.
296296
* `platform add <Platform>` adds a new target platform to your project.
@@ -317,21 +317,41 @@ Run `tns help` to view all available commands in the browser. Run `tns help <Com
317317

318318
## Create Project
319319

320-
To create a new cross-platform project from the default template, run the following command.
320+
To create a new cross-platform project from the default JavaScript template, run the following command.
321321

322322
```Shell
323323
tns create MyApp
324324
```
325325

326+
To create a new cross-platform project from the default TypeScript or Angular template, use the `template` option followed by either `typescript`, or `angular`.
327+
328+
```Shell
329+
tns create MyApp --template typescript
330+
tns create MyApp --template angular
331+
```
332+
333+
Or you can simply use the shorthand `tsc` and `ng` options.
334+
335+
```Shell
336+
tns create MyApp --tsc
337+
tns create MyApp --ng
338+
```
339+
With the `template` option you can also specify a local or a remote path to the template that you want to use to create your project.
340+
For example, if you want to use the nightly build of the default JavaScript template, run the following command.
341+
342+
```Shell
343+
tns create MyApp --template https://github.com/NativeScript/template-hello-world.git
344+
```
345+
326346
To create a new cross-platform project from an existing NativeScript project, run the following command.
327347

328348
```Shell
329349
tns create MyApp --copy-from <Directory>
330350
```
331351

332-
Where <Directory> is the complete path to the directory that contains your existing project. You can use any NativeScript project, created with the Telerik AppBuilder clients.
352+
Where `<Directory>` is the complete path to the directory that contains your existing project. You can use any NativeScript project, created with the Telerik AppBuilder clients.
333353

334-
The NativeScript creates a new project based on the JavaScript built-in template and sets the application identifier to `org.nativescript.myapp`.
354+
The NativeScript CLI creates a new project and sets the application identifier to `org.nativescript.myapp`.
335355

336356
The CLI places the project in a new directory in the current directory. The newly created directory has the following structure.
337357

@@ -389,13 +409,13 @@ platforms/
389409
|-- |-- libTNSBridge.a
390410
|-- |-- node_modules
391411
`-- |-- MyApp/
392-
`-- MyApp.xcodeproj
412+
`-- MyApp.xcodeproj
393413
...
394414
```
395415
396416
For more information about the structure of Android native projects, see [Android Projects](http://developer.android.com/tools/projects/index.html#ApplicationProjects).
397417
398-
For more information about the structure iOS native projects, see [Code Organization in Xcode Projects](http://akosma.com/2009/07/28/code-organization-in-xcode-projects/).
418+
For more information about the structure of iOS native projects, see [Code Organization in Xcode Projects](http://akosma.com/2009/07/28/code-organization-in-xcode-projects/).
399419
400420
> **TIP:** The NativeScript team provides experimental support for the latest versions of iOS and Android. You can choose which platform runtime to use in your project by running `tns platform add <platform>@<Version>`<br/>To list all available versions for android, run $ npm view tns-android versions<br/>To list only experimental versions for android, run $ npm view tns-android dist-tags
401421
To list all available versions for ios, run $ npm view tns-ios versions<br/>To list only experimental versions for ios, run $ npm view tns-ios dist-tags
@@ -568,11 +588,11 @@ Known Issues
568588
* You cannot synchronize changes to apps on Android 4.3 devices and on some Samsung devices using the `livesync android` command.<br/>**Workaround:** Upgrade to a later version of Android to be able to use the `livesync` command. If you need to develop for Android 4.3 devices, re-build and re-deploy your app to get your latest changes on device.
569589
570590
* On OS X systems with configured firewall or web proxy, when you run a command, the operation might not release the command line and you might not be able to run other commands until you break the current operation.<br/>If you have enabled feature usage tracking for the NativeScript CLI, but you have not authenticated with the firewall or web proxy on your OS X system, the NativeScript CLI might not release the command line after you run a command. To continue working with the NativeScript CLI, you need to break the current operation by pressing `Ctrl+C`.<br/>**Workaround:** Authenticate with the firewall or web proxy.
571-
1. Close the terminal.
572-
1. Run Safari.
573-
1. Attempt to open a web page.
574-
1. Provide your authentication credentials for accessing the Internet.
575-
1. Run the terminal and continue working with the NativeScript CLI.
591+
1. Close the terminal.
592+
1. Run Safari.
593+
1. Attempt to open a web page.
594+
1. Provide your authentication credentials for accessing the Internet.
595+
1. Run the terminal and continue working with the NativeScript CLI.
576596
577597
[Back to Top][1]
578598

0 commit comments

Comments
 (0)