Skip to content

chore: show the CLI diagram in a separate section with some explanations #3318

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

Merged
merged 3 commits into from
Jan 15, 2018
Merged

chore: show the CLI diagram in a separate section with some explanations #3318

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f4b0d1e
chore: show the CLI diagram in a separate section with some explanations
tbozhikov Jan 12, 2018
ba7c505
chore: use bold for emphasis
tbozhikov Jan 12, 2018
53c59f7
chore: fixes following PR
tbozhikov Jan 15, 2018
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
20 changes: 16 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,10 @@ NativeScript Command-Line Interface
Master Branch [![Build Status](https://travis-ci.org/NativeScript/nativescript-cli.svg?branch=build)][2].
Get it using: `npm install nativescript@next -g`

* Create, build, and run native apps for iOS and Android using JavaScript or TypeScript *

The NativeScript CLI lets you create, build, and deploy [NativeScript][7]-based projects on iOS and Android devices.

![NativeScript CLI diagram](https://github.com/NativeScript/nativescript-cli/blob/master/ns-cli.png)

* [What is NativeScript](#what-is-nativescript "Quick overview of NativeScript, the JavaScript framework for cross-platform development of native iOS and Android apps")
* [How the NativeScript CLI works](#how-the-nativescript-cli-works "How the CLI works in more detail")
* [Supported Platforms](#supported-platforms "The mobile platforms you can target with NativeScript")
* [System Requirements](#system-requirements "The hardware and software requirements for setting up and working with the NativeScript CLI")
* [Installation](#installation "How to configure and install the NativeScript CLI")
Expand Down Expand Up @@ -48,6 +45,21 @@ To learn more about NativeScript, you can check the following resources:

[Back to Top][1]

How the NativeScript CLI works
===

The NativeScript CLI is the command-line interface for interacting with NativeScript. It incorporates several important services. Consider the following diagram:

![NativeScript CLI diagram](https://github.com/NativeScript/nativescript-cli/blob/master/ns-cli.png)

* **Commands** - pretty much what every CLI does - support of different command options, input validation and help
* **Devices Service** - provides the communication between NativeScript and devices/emulators/simulators used to run/debug the app. Uses iTunes to talk to iOS and adb for Android
* **LiveSync Service** - redeploys applications when code changes during development
* **Hooks Service** - executes custom-written hooks in developed application, thus modifying the build process
* **Platforms Service** - provides app build functionalities, uses Gradle to build Android packages and Xcode for iOS.

[Back to Top][1]

Supported Platforms
===

Expand Down