Skip to content

Commit bb153b5

Browse files
docs: update quick start
1 parent 93ef637 commit bb153b5

File tree

1 file changed

+30
-15
lines changed

1 file changed

+30
-15
lines changed

docs/installation/quick_start.md

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -33,30 +33,45 @@ Hardware requirements vary significantly depending on model and image output siz
3333

3434
More detail on system requirements can be found [here](./requirements.md).
3535

36-
## Step 2: Download
36+
## Step 2: Download and Set Up the Launcher
3737

38-
Download the most recent launcher for your operating system:
38+
The Launcher manages your Invoke install. Follow these instructions to download and set up the Launcher.
3939

40-
- [Download for Windows](https://github.com/invoke-ai/launcher/releases/latest/download/Invoke.Community.Edition.Setup.latest.exe)
41-
- [Download for macOS](https://github.com/invoke-ai/launcher/releases/latest/download/Invoke.Community.Edition-latest-arm64.dmg)
42-
- [Download for Linux](https://github.com/invoke-ai/launcher/releases/latest/download/Invoke.Community.Edition-latest.AppImage)
40+
!!! info "Instructions for each OS"
4341

44-
## Step 3: Install or Update
42+
=== "Windows"
4543

46-
Run the launcher you just downloaded, click **Install** and follow the instructions to get set up.
44+
- [Download for Windows](https://github.com/invoke-ai/launcher/releases/latest/download/Invoke.Community.Edition.Setup.latest.exe)
45+
- Run the `EXE` to install the Launcher and start it.
46+
- A desktop shortcut will be created; use this to run the Launcher in the future.
47+
- You can delete the `EXE` file you downloaded.
4748

48-
If you have an existing Invoke installation, you can select it and let the launcher manage the install. You'll be able to update or launch the installation.
49+
=== "macOS"
50+
51+
- [Download for macOS](https://github.com/invoke-ai/launcher/releases/latest/download/Invoke.Community.Edition-latest-arm64.dmg)
52+
- Open the `DMG` and drag the app into `Applications`.
53+
- Run the Launcher using its entry in `Applications`.
54+
- You can delete the `DMG` file you downloaded.
55+
56+
=== "Linux"
57+
58+
- [Download for Linux](https://github.com/invoke-ai/launcher/releases/latest/download/Invoke.Community.Edition-latest.AppImage)
59+
- You may need to edit the `AppImage` file properties and make it executable.
60+
- Optionally move the file to a location that does not require admin privileges and add a desktop shortcut for it.
61+
- Run the Launcher by double-clicking the `AppImage` or the shortcut you made.
4962

50-
!!! warning "Problem running the launcher on macOS"
63+
## Step 3: Install Invoke
64+
65+
Run the Launcher you just set up if you haven't already. Click **Install** and follow the instructions to install (or update) Invoke.
66+
67+
If you have an existing Invoke installation, you can select it and let the launcher manage the install. You'll be able to update or launch the installation.
5168

52-
macOS may not allow you to run the launcher. We are working to resolve this by signing the launcher executable. Until that is done, you can manually flag the launcher as safe:
69+
!!! tip "Updating"
5370

54-
- Open the **Invoke Community Edition.dmg** file.
55-
- Drag the launcher to **Applications**.
56-
- Open a terminal.
57-
- Run `xattr -d 'com.apple.quarantine' /Applications/Invoke\ Community\ Edition.app`.
71+
The Launcher will check for updates for itself _and_ Invoke.
5872

59-
You should now be able to run the launcher.
73+
- When the Launcher detects an update is available for itself, you'll get a small popup window. Click through this and the Launcher will update itself.
74+
- When the Launcher detects an update for Invoke, you'll see a small green alert in the Launcher. Click that and follow the instructions to update Invoke.
6075

6176
## Step 4: Launch
6277

0 commit comments

Comments
 (0)