Skip to content

Updated system requirements #264

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

Updated system requirements #264

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
64b55f3
Updated system requirements
ikoevska Feb 28, 2015
fe6b42c
Fixed Mono req as per comments
ikoevska Mar 4, 2015
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
71 changes: 56 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,18 +61,19 @@ You can install and run the NativeScript CLI on Windows or OS X.

* [Windows](#widnows)
* [OS X](#os-x)
* [Linux](#linux)

## Windows

> On Windows systems, you can develop, build, and deploy NativeScript projects that target Android.

* Windows Vista or later
* [Node.js 0.10.26] or a later stable official release
* (Optional) [Chocolatey]
* [JDK 6] or a later stable official release
* [Apache Ant 1.8] or a later stable official release
* [Android SDK 19] or a later stable official release
* (Optional) [Genymotion]
* [Node.js 0.10.26][Node.js 0.10.26] or a later stable official release
* (Optional) [Chocolatey][Chocolatey]
* [JDK 7][JDK 7] or a later stable official release
* [Apache Ant 1.8][Apache Ant 1.8] or a later stable official release
* [Android SDK 19][Android SDK 19] or a later stable official release
* (Optional) [Genymotion][Genymotion]

If you want to develop for Android, verify that you have added the following paths in the `PATH` system environment variable.

Expand Down Expand Up @@ -136,17 +137,16 @@ If you have installed Chocolatey, you can complete these steps to set up JDK, Ap
> On OS X systems, you can develop, build, and deploy NativeScript projects that target iOS and Android.

* OS X Mavericks
* [Node.js 0.10.26] or a later stable official release
* [Node.js 0.10.26][Node.js 0.10.26] or a later stable official release
* For iOS development
* [iOS 7.0 SDK][12] or a later stable official release
* [Xcode 5][12] or a later stable official release
* [Xcode 6][12] or a later stable official release
* [Xcode command-line tools][12]
Copy link
Contributor

Choose a reason for hiding this comment

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

If I remember correctly, only 64 bit Mono works. Someone from the NS team should confirm.

Copy link
Contributor

Choose a reason for hiding this comment

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

The 64-bit Mono is required in case users want to use the new library add command. We may include this as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This last comment is unclear. What may we include? the Mono req or that Mono is req-ed for library add or something about library add?

If the comments is about the Mono req being listed as a whole, please, take a look at line 144 - it's already there.

And finally, should it or shoildn't it be 64-bit?

Copy link
Contributor

Choose a reason for hiding this comment

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

Finally, it should be 64-bit; and it is required only when library add is used.

* (Optional) [Mono] installed via Homebrew
* (Optional) [Mono][Mono] installed via Homebrew
* For Android development
* [JDK 6] or a later stable official release
* [Apache Ant 1.8] or a later stable official release
* [Android SDK 19] or a later stable official release
* (Optional) [Genymotion]
* [JDK 7][JDK 7] or a later stable official release
* [Apache Ant 1.8][Apache Ant 1.8] or a later stable official release
* [Android SDK 19][Android SDK 19] or a later stable official release
* (Optional) [Genymotion][Genymotion]

If you want to develop for Android, verify that you have added the following paths in your `PATH` in `~/.bash_profile`.

Expand All @@ -161,6 +161,45 @@ For example:
export PATH=${PATH}:/ant/apache-ant-1.9.4/bin:/Applications/Android Studio.app/sdk/tools:/Applications/Android Studio.app/sdk/platform-tools
```

## Linux

> On Linux systems, you can develop, build, and deploy NativeScript projects that target Android.

* Ubuntu 14.04 LTS
* [Node.js 0.10.26][Node.js 0.10.26] or a later stable official release<br/>If installed via `sudo apt-get install`, use the `nodejs-legacy` package.

```Shell
sudo apt-get install nodejs-legacy
```
* G++ compiler

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

```Shell
sudo apt-get install lib32z1 lib32ncurses5 lib32bz2-1.0 libstdc++6:i386
```
* [JDK 7][JDK 7] or a later stable official release
* [Apache Ant 1.8][Apache Ant 1.8] or a later stable official release
* [Android SDK 19][Android SDK 19] or a later stable official release
* (Optional) [Genymotion][Genymotion]

Verify that you have added the following paths in your `PATH`.

```
Path to the bin subdirectory in the Apache Ant installation directory
Path to the tools subdirectory in the Android SDK installation directory
Path to the platform-tools subdirectory in the Android SDK installation directory
```

For example:
```
export PATH=${PATH}:/ant/apache-ant-1.9.4/bin:/Applications/Android Studio.app/sdk/tools:/Applications/Android Studio.app/sdk/platform-tools
```

[Back to Top][1]

Installation
Expand All @@ -174,6 +213,8 @@ In the command prompt, run the following command.
npm install nativescript -g
```

> On OS X and Linux systems, you might need to run this command using sudo.

[Back to Top][1]

Quick Start
Expand Down Expand Up @@ -468,7 +509,7 @@ This software is licensed under the Apache 2.0 license, quoted <a href="LICENSE"
[12]: https://developer.apple.com/xcode/downloads/
[Node.js 0.10.26]: http://nodejs.org/download/
[Chocolatey]: https://chocolatey.org/
[JDK 6]: http://www.oracle.com/technetwork/java/javase/downloads/index.html
[JDK 7]: http://www.oracle.com/technetwork/java/javase/downloads/index.html
[Apache Ant 1.8]: http://ant.apache.org/bindownload.cgi
[Android SDK 19]: http://developer.android.com/sdk/index.html
[Genymotion]: https://www.genymotion.com/#!/
Expand Down
11 changes: 4 additions & 7 deletions resources/help.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,15 +415,12 @@ Options:
--[debug]--

Usage:
$ tns debug <Platform> [--device <Device ID>] [--debug-brk | --start | --stop | --get-port] [--debug-port <port>]
$ nativescript debug <Platform> [--device <Device ID>] [--debug-brk | --start | --stop | --get-port] [--debug-port <port>]
$ tns debug <Platform> [--device <Device ID>] [--debug-brk | --start | --stop | --get-port] [--debug-port <Port>]

Platform-specific usage:
$ tns debug android --get-port
$ tns debug android --debug-brk
$ tns debug ios --debug-brk
$ nativescript debug android --debug-brk
$ nativescript debug ios --start

Debugs your project on a connected device or in the native emulator, if configured. This is shorthand for prepare, build, and deploy.
<Device ID> is the index or name of the target device as listed by $ tns list-devices.
Expand All @@ -446,7 +443,7 @@ Options:
--[emulate]--

Usage:
$ tns emulate emulate <Command> [--release]
$ tns emulate <Command> [--release]

You must run the emulate command with a related command.

Expand Down Expand Up @@ -541,7 +538,7 @@ Before running the iOS Simulator, verify that you have met the following require
NativeScript CLI depends. For more information, visit https://www.npmjs.org/package/ios-sim-portable

Options:
--availableDevices - Lists all available device type identifiers for the current XCode.
--availableDevices - Lists all available device type identifiers for the current Xcode.
--release - If set, produces a release build. Otherwise, produces a debug build.
--path - Specifies the directory that contains the project. If not specified, the project is searched
for in the current directory and all directories above it.
Expand Down Expand Up @@ -621,7 +618,7 @@ You can run this command on one connected device at a time.
Prerequisites:
Before running your app on an iOS device, verify that your system and app meet the following requirements.
* You are running the NativeScript CLI on an OS X system.
* You have installed Xcode 5 or later.
* You have installed Xcode 6 or later.
* You have built your app with the debug build configuration.
Before running your app on an Android device, verify that your app meets the following requirement.
* You have built your app with the debug build configuration.
Expand Down