InvokeAI

mirror of https://github.com/invoke-ai/InvokeAI synced 2024-08-30 20:32:17 +00:00

History

Lincoln Stein f7170e4156 improve installation documentation 1. Added a big fat warning to the Windows installer to tell user to install Visual C++ redistributable. 2. Added a bit fat warning to the automated installer doc to tell user the same thing. 3. Reordered entries on the table-of-contents sidebar for installation to prioritize the most important docs. 4. Moved older installation documentation into deprecated folder. 5. Moved developer-specific installation documentation into the developers folder.		2022-12-16 10:26:02 +13:00
..
templates	Simple Installer for Unified Directory Structure, Initial Implementation (#1819 )	2022-12-11 00:37:08 -05:00
create_installer.sh	Lstein installer improvements (#1954 )	2022-12-13 01:15:11 -05:00
install.bat.in	improve installation documentation	2022-12-16 10:26:02 +13:00
install.sh.in	(install) fix segfault on macos when using homebrew	2022-12-13 11:39:08 -05:00
readme.txt	Simple Installer for Unified Directory Structure, Initial Implementation (#1819 )	2022-12-11 00:37:08 -05:00
WinLongPathsEnabled.reg	Simple Installer for Unified Directory Structure, Initial Implementation (#1819 )	2022-12-11 00:37:08 -05:00

readme.txt

InvokeAI

Project homepage: https://github.com/invoke-ai/InvokeAI

Preparations:

  You will need to install Python 3.9 or higher for this installer
  to work. Instructions are given here:
  https://invoke-ai.github.io/InvokeAI/installation/INSTALL_AUTOMATED/

  Before you start the installer, please open up your system's command
  line window (Terminal or Command) and type the commands:

     python --version

  If all is well, it will print "Python 3.X.X", where the version number
  is at least 3.9.1

  If this works, check the version of the Python package manager, pip:

     pip --version

  You should get a message that indicates that the pip package
  installer was derived from Python 3.9 or 3.10. For example:
  "pip 22.3.1 from /usr/bin/pip (python 3.9)"

Long Paths on Windows:

  If you are on Windows, you will need to enable Windows Long Paths to
  run InvokeAI successfully. If you're not sure what this is, you
  almost certainly need to do this.

  Simply double-click the "WinLongPathsEnabled.reg" file located in
  this directory, and approve the Windows warnings. Note that you will
  need to have admin privileges in order to do this.

Launching the installer:

  Windows: double-click the 'install.bat' file (while keeping it inside
  the InvokeAI-Installer folder).

  Linux and Mac: Please open the terminal application and run
  './install.sh' (while keeping it inside the InvokeAI-Installer
  folder).

The installer will create a directory named "invokeai" in the folder
of your choice. This directory contains everything you need to run
invokeai. Once InvokeAI is up and running, you may delete the
InvokeAI-Installer folder at your convenience.

For more information, please see
https://invoke-ai.github.io/InvokeAI/installation/INSTALL_AUTOMATED/