Skip to content

Commit 5ef1e07

Browse files
committed
Merge branch 'main' of github.com:/invoke-ai/InvokeAI into main
2 parents be871c3 + dec40d9 commit 5ef1e07

3 files changed

Lines changed: 31 additions & 11 deletions

File tree

docs/installation/INSTALL_SOURCE.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,18 +50,30 @@ 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 macOS user, you may need to install the Xcode command line tools.
54+
These are a set of tools that are needed to run certain applications in a Terminal,
55+
including InvokeAI. This package is provided directly by Apple.
56+
57+
To install, open a terminal window and run `xcode-select --install`. You will get
58+
a macOS system popup guiding you through the install. If you already have them
59+
installed, you will instead see some output in the Terminal advising you that the
60+
tools are already installed.
61+
62+
More information can be found here:
63+
https://www.freecodecamp.org/news/install-xcode-command-line-tools/
64+
65+
4. If you are using a desktop GUI, double-click the installer file. It will be
5466
named `install.bat` on Windows systems and `install.sh` on Linux and
5567
Macintosh systems.
5668
57-
4. Alternatively, from the command line, run the shell script or .bat file:
69+
5. Alternatively, from the command line, run the shell script or .bat file:
5870
5971
```cmd
6072
C:\Documents\Linco> cd invokeAI
6173
C:\Documents\Linco\invokeAI> install.bat
6274
```
6375
64-
5. Sit back and let the install script work. It will install various binary
76+
6. Sit back and let the install script work. It will install various binary
6577
requirements including Conda, Git and Python, then download the current
6678
InvokeAI code and install it along with its dependencies.
6779
@@ -74,7 +86,7 @@ off the process.
7486
and nothing is happening, you can interrupt the script with ^C. You may restart
7587
it and it will pick up where it left off.
7688
77-
6. After installation completes, the installer will launch a script called
89+
7. After installation completes, the installer will launch a script called
7890
`configure_invokeai.py`, which will guide you through the first-time process of
7991
selecting one or more Stable Diffusion model weights files, downloading and
8092
configuring them.
@@ -90,7 +102,7 @@ off the process.
90102
prompted) and configure InvokeAI to use the previously-downloaded files. The
91103
process for this is described in [Installing Models](INSTALLING_MODELS.md).
92104
93-
7. The script will now exit and you'll be ready to generate some images. The
105+
8. The script will now exit and you'll be ready to generate some images. The
94106
invokeAI directory will contain numerous files. Look for a shell script
95107
named `invoke.sh` (Linux/Mac) or `invoke.bat` (Windows). Launch the script
96108
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 install"
121+
echo "the Xcode command line tools to proceed. See step number 3 of"
122+
echo "https://invoke-ai.github.io/InvokeAI/INSTALL_SOURCE#walk_through for"
123+
echo "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)