Skip to content

Commit 72def2a

Browse files
committed
documentation fixes for 2.2.3
- Add Xcode installation instructions to source installer walkthrough - Fix link to source installer page from installer overview - If OSX install crashes, script will tell Mac users to go to the docs to learn how to install Xcode
1 parent 5c31feb commit 72def2a

3 files changed

Lines changed: 30 additions & 14 deletions

File tree

docs/installation/INSTALL_SOURCE.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ off the process.
2929
[latest release](https://github.com/invoke-ai/InvokeAI/releases/latest), and
3030
look for a series of files named:
3131

32-
- invokeAI-src-installer-mac.zip
33-
- invokeAI-src-installer-windows.zip
34-
- invokeAI-src-installer-linux.zip
32+
- invokeAI-src-installer-<VERSION>-mac.zip
33+
- invokeAI-src-installer-<VERSION>-windows.zip
34+
- invokeAI-src-installer-<VERSION>-linux.zip
3535

3636
Download the one that is appropriate for your operating system.
3737

@@ -50,18 +50,26 @@ off the process.
5050
inflating: invokeAI\readme.txt
5151
```
5252
53-
3. If you are using a desktop GUI, double-click the installer file. It will be
53+
3. If you are a Macintosh user, you may need to authorize the InvokeAI
54+
installer by opening a terminal window and typing `xcode-select
55+
--install`. Alternatively, you may install Xcode thorugh a graphical
56+
user interface. Information is available at https://www.freecodecamp.org/news/how-to-download-and-install-xcode/
57+
58+
If installation fails with an `EnvironmentNameNotFound` error, then
59+
you will need to install Xcode!!
60+
61+
4. If you are using a desktop GUI, double-click the installer file. It will be
5462
named `install.bat` on Windows systems and `install.sh` on Linux and
5563
Macintosh systems.
5664
57-
4. Alternatively, from the command line, run the shell script or .bat file:
65+
5. Alternatively, from the command line, run the shell script or .bat file:
5866
5967
```cmd
6068
C:\Documents\Linco> cd invokeAI
6169
C:\Documents\Linco\invokeAI> install.bat
6270
```
6371
64-
5. Sit back and let the install script work. It will install various binary
72+
6. Sit back and let the install script work. It will install various binary
6573
requirements including Conda, Git and Python, then download the current
6674
InvokeAI code and install it along with its dependencies.
6775
@@ -74,7 +82,7 @@ off the process.
7482
and nothing is happening, you can interrupt the script with ^C. You may restart
7583
it and it will pick up where it left off.
7684
77-
6. After installation completes, the installer will launch a script called
85+
7. After installation completes, the installer will launch a script called
7886
`configure_invokeai.py`, which will guide you through the first-time process of
7987
selecting one or more Stable Diffusion model weights files, downloading and
8088
configuring them.
@@ -90,7 +98,7 @@ off the process.
9098
prompted) and configure InvokeAI to use the previously-downloaded files. The
9199
process for this is described in [Installing Models](INSTALLING_MODELS.md).
92100
93-
7. The script will now exit and you'll be ready to generate some images. The
101+
8. The script will now exit and you'll be ready to generate some images. The
94102
invokeAI directory will contain numerous files. Look for a shell script
95103
named `invoke.sh` (Linux/Mac) or `invoke.bat` (Windows). Launch the script
96104
by double-clicking it or typing its name at the command-line:

docs/installation/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Overview
55
We offer several ways to install InvokeAI, each one suited to your
66
experience and preferences.
77

8-
1. InvokeAI source code installer
8+
1. [InvokeAI source code installer](INSTALL_SOURCE.md)
99
This is a script that will install Python, the Anaconda ("conda")
1010
package manager, all of InvokeAI's its essential third party
1111
libraries and InvokeAI itself. It includes access to a "developer
@@ -18,7 +18,8 @@ experience and preferences.
1818
stay on the cutting edge of InvokeAI development and are not
1919
afraid of occasional breakage.
2020

21-
To get started go to the bottom of the [Latest Release Page](https://github.com/invoke-ai/InvokeAI/releases/latest)
21+
To get started go to the bottom of the
22+
[Latest Release Page](https://github.com/invoke-ai/InvokeAI/releases/latest)
2223
and download the .zip file for your platform. Unzip the file.
2324
If you are on a Windows system, double-click on the `install.bat`
2425
script. On a Mac or Linux system, navigate to the file `install.sh`

source_installer/install.sh.in

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -116,10 +116,17 @@ status=$?
116116

117117
if test $status -ne 0
118118
then
119-
echo "Something went wrong while installing Python libraries and cannot continue."
120-
echo "See https://invoke-ai.github.io/InvokeAI/INSTALL_SOURCE#troubleshooting for troubleshooting"
121-
echo "tips, or visit https://invoke-ai.github.io/InvokeAI/#installation for alternative"
122-
echo "installation methods"
119+
if [ "$OS_NAME" == "osx" ]; then
120+
echo "Python failed to install the environment. You may need to authorize"
121+
echo "it to do so by installing the Xcode tools. See step number 3 of"
122+
echo "https://invoke-ai.github.io/InvokeAI/INSTALL_SOURCE#walk_through for"
123+
echo "Xcode installation instructions and then run this script again."
124+
else
125+
echo "Something went wrong while installing Python libraries and cannot continue."
126+
echo "See https://invoke-ai.github.io/InvokeAI/INSTALL_SOURCE#troubleshooting for troubleshooting"
127+
echo "tips, or visit https://invoke-ai.github.io/InvokeAI/#installation for alternative"
128+
echo "installation methods"
129+
fi
123130
else
124131
ln -sf ./source_installer/invoke.sh.in ./invoke.sh
125132
ln -sf ./source_installer/update.sh.in ./update.sh

0 commit comments

Comments
 (0)