Skip to content

Commit

Permalink
[docs] Describe installation
Browse files Browse the repository at this point in the history
  • Loading branch information
jjonescz committed Jul 31, 2019
1 parent 00b7a5b commit 59ce103
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ If you want to use the emulator, you can either [build it from
sources](docs/build.md) (that's slow), [use partially prebuilt
artifacts](docs/artifacts.md) (that's fast and recommended if you want to make
changes; however, you still need to have Docker and Visual Studio installed) or
just [use prebuilt binaries](https://github.com/ipasimulator/ipasim/releases)
(recommended if you don't want to make changes).
just [use prebuilt binaries](docs/install.md) (recommended if you don't want to
make changes).

## Directory structure

Expand Down
21 changes: 21 additions & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Installation

This document describes steps necessary to install the emulator from [GitHub
releases](https://github.com/ipasimulator/ipasim/releases).

1. Make sure you have Windows 10, build 1809 or later.
2. Download and extract `ipasim-build-v*.zip` of your chosen
[release](https://github.com/ipasimulator/ipasim/releases).
3. Run script `Add-AppDevPackage.ps1` from the extracted files. Follow
instructions in the console. If successful, you will have the emulator
installed on your machine (it's called `ipaSim`).

## Samples

If you don't have your own iOS app to emulate, you can use a prebuilt sample.

1. Download and extract `ipasim-samples-v*.zip` of your chosen
[release](https://github.com/ipasimulator/ipasim/releases) or some previous
one (samples may not be built that often).
2. Launch `ipaSim` and select one of the extracted folders (it must have suffix
`.app`).

0 comments on commit 59ce103

Please sign in to comment.