Skip to content

Commit 6002106

Browse files
ikoevskaikoevska
committed
Merge pull request #11 from telerik/ikoevska/docs-refine
Refining the docs
2 parents 0c937c0 + 769d4b7 commit 6002106

File tree

3 files changed

+303
-8
lines changed

3 files changed

+303
-8
lines changed

‎LICENSE

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright 2014 Telerik AD
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.md

Lines changed: 87 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,90 @@
11
ios-sim-portable
22
================
33

4-
The ios-sim-portable is a command-line utility written in nodejs that launches an iOS application on the iOS Simulator.
4+
The ios-sim-portable is a command-line utility written in Node.js that launches an [iOS application bundle (.app)][5] in the Xcode [iOS Simulator][4].
5+
6+
* [System Requirements](#system-requirements)
7+
* [Installation](#installation)
8+
* [Usage](#usage)
9+
* [License](#license)
10+
* [Related npm Packages](#related-npm-packages)
11+
12+
System Requirements
13+
===================
14+
15+
* OS X 10.9.4 or later
16+
* Node.js 0.10.26 or later
17+
* Xcode 5.0 or later
18+
* Command Line Tools for Xcode, compatible with your versions of Xcode and OS X
19+
* iOS 7.0 SDK or later
20+
21+
[Back to Top][1]
22+
23+
Installation
24+
============
25+
26+
To install ios-sim-portable, run the following command.
27+
28+
```bash
29+
npm i -g ios-sim-portable
30+
```
31+
32+
To update ios-sim-portable, run the following command.
33+
34+
```bash
35+
npm update -g ios-sim-portable
36+
```
37+
38+
To uninstall ios-sim-portable, run the following command.
39+
40+
```bash
41+
npm uninstall -g ios-sim-portable
42+
```
43+
44+
[Back to Top][1]
45+
46+
Usage
47+
=====
48+
49+
```bash
50+
$ ios-sim-portable <command> [parameters] [--options <values>]
51+
$ isim <command> [parameters] [--options <values>]
52+
53+
General commands:
54+
help <command> Shows additional information about the commands in this list.
55+
launch <full path> Launches the application bundle at the specified path in the iOS Simulator.
56+
device-types Lists the available device types for the current Xcode version.
57+
sdks Lists the available iOS SDK versions.
58+
59+
For more information about each command, run
60+
$ isim help <command>
61+
or
62+
$ isim <command> --help
63+
64+
```
65+
66+
[Back to Top][1]
67+
68+
License
69+
=======
70+
71+
This software is licensed under the Apache 2.0 license, quoted <a href="LICENSE" target="_blank">here</a>.
72+
73+
[Back to Top][1]
74+
75+
Related npm Packages
76+
================
77+
78+
Both the Telerik AppBuilder CLI (`appbuilder`) and the NativeScript CLI (`nativescript`) rely on ios-sim-portable to load projects in the iOS Simulator.
79+
80+
The [Telerik AppBuilder CLI][2] lets you build, test, deploy, and publish hybrid mobile apps for iOS, Android, and Windows Phone 8 from your favorite IDE or code editor.
81+
82+
The [NativeScript CLI][3] lets you create, build, and deploy Telerik NativeScript-based projects on iOS and Android devices.
83+
84+
[Back to Top][1]
85+
86+
[1]: #ios-sim-portable
87+
[2]: https://www.npmjs.org/package/appbuilder
88+
[3]: https://www.npmjs.org/package/nativescript
89+
[4]: https://developer.apple.com/library/ios/documentation/IDEs/Conceptual/iOS_Simulator_Guide/Introduction/Introduction.html
90+
[5]: https://developer.apple.com/library/ios/documentation/CoreFoundation/Conceptual/CFBundles/AboutBundles/AboutBundles.html#//apple_ref/doc/uid/10000123i-CH100-SW1

‎resources/help.txt

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
--[]--
22

33
Usage:
4-
$ ios-sim-portable <command> [command parameters] [--command <options>]
4+
$ ios-sim-portable <command> [parameters] [--options <values>]
5+
$ isim <command> [parameters] [--options <values>]
56

67
General commands:
78
help <command> Shows additional information about the commands in this list.
8-
launch <path> Launches the application at the specified path in the iOS Simulator.
9-
device-types Lists the available device types for the current XCode version.
9+
launch <full path> Launches the application bundle (.app) at the specified path in the iOS Simulator.
10+
device-types Lists the available device types for the current Xcode version.
1011
sdks Lists the available iOS SDK versions.
1112

1213
General options:
@@ -18,6 +19,7 @@ General options:
1819

1920
Usage:
2021
$ ios-sim-portable help [<Command>]
22+
$ isim help [<Command>]
2123

2224
Lists the available commands or shows information about the selected command.
2325
<Command> is any of the available commands as listed by $ ios-sim-portable help.
@@ -27,29 +29,34 @@ Lists the available commands or shows information about the selected command.
2729
--[launch]--
2830

2931
Usage:
30-
$ ios-sim-portable launch <Path> [--exit]
32+
$ ios-sim-portable launch <Full Path> [--exit] [--device <Name>]
33+
$ isim launch <Full Path> [--exit] [--device <Name>]
3134

32-
Launches the application located at the specified path in the iOS Simulator.
33-
<Path> is the file path to the application file (.app) that you want to load in the iOS Simulator.
35+
Launches the application bundle (.app) located at the specified path in the iOS Simulator.
36+
<Full Path> is the absolute file path to the application bundle (.app) that you want to load in the iOS Simulator.
37+
<Name> is the name of an available device as listed by $ ios-sim-portable device-types.
3438

3539
Options:
3640
--exit - If set, releases the console after the iOS Simulator starts.
41+
--device - If set, launches the app in the selected device. Otherwise, launches the app in the default device.
3742

3843
--[/]--
3944

4045
--[device-types]--
4146

4247
Usage:
4348
$ ios-sim-portable device-types
49+
$ isim device-types
4450

45-
Lists the available device types for the current XCode version.
51+
Lists the available device types for the current Xcode version.
4652

4753
--[/]--
4854

4955
--[sdks]--
5056

5157
Usage:
5258
$ ios-sim-portable sdks
59+
$ isim sdks
5360

5461
Lists the available iOS SDK versions.
5562

0 commit comments

Comments
 (0)