From 59ce1031b59d33ec3510db0dd80943fa6a7e1fe5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Jone=C5=A1?= Date: Wed, 31 Jul 2019 15:58:19 +0200 Subject: [PATCH] [docs] Describe installation --- README.md | 4 ++-- docs/install.md | 21 +++++++++++++++++++++ 2 files changed, 23 insertions(+), 2 deletions(-) create mode 100644 docs/install.md diff --git a/README.md b/README.md index 7aa75f68..89087b3f 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/install.md b/docs/install.md new file mode 100644 index 00000000..7ad21540 --- /dev/null +++ b/docs/install.md @@ -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`).