Skip to content

Commit 59ce103

Browse files
committed
[docs] Describe installation
1 parent 00b7a5b commit 59ce103

File tree

2 files changed

+23
-2
lines changed

2 files changed

+23
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ If you want to use the emulator, you can either [build it from
2828
sources](docs/build.md) (that's slow), [use partially prebuilt
2929
artifacts](docs/artifacts.md) (that's fast and recommended if you want to make
3030
changes; however, you still need to have Docker and Visual Studio installed) or
31-
just [use prebuilt binaries](https://github.com/ipasimulator/ipasim/releases)
32-
(recommended if you don't want to make changes).
31+
just [use prebuilt binaries](docs/install.md) (recommended if you don't want to
32+
make changes).
3333

3434
## Directory structure
3535

docs/install.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Installation
2+
3+
This document describes steps necessary to install the emulator from [GitHub
4+
releases](https://github.com/ipasimulator/ipasim/releases).
5+
6+
1. Make sure you have Windows 10, build 1809 or later.
7+
2. Download and extract `ipasim-build-v*.zip` of your chosen
8+
[release](https://github.com/ipasimulator/ipasim/releases).
9+
3. Run script `Add-AppDevPackage.ps1` from the extracted files. Follow
10+
instructions in the console. If successful, you will have the emulator
11+
installed on your machine (it's called `ipaSim`).
12+
13+
## Samples
14+
15+
If you don't have your own iOS app to emulate, you can use a prebuilt sample.
16+
17+
1. Download and extract `ipasim-samples-v*.zip` of your chosen
18+
[release](https://github.com/ipasimulator/ipasim/releases) or some previous
19+
one (samples may not be built that often).
20+
2. Launch `ipaSim` and select one of the extracted folders (it must have suffix
21+
`.app`).

0 commit comments

Comments
 (0)