InvokeAI

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

History

Eugene Brodsky f0cd1aa736 highlight key elements of installer welcome message - help users to avoid glossing over per-platform prerequisites - better link colouring - update link to community instructions to install xcode command line tools		2023-02-06 00:57:29 -05:00
..
templates	Merge branch 'main' into bugfix/use-cu117-wheel	2023-02-04 09:43:52 -05:00
__init__.py	(installer) initial work on the installer	2023-01-28 17:39:32 -05:00
create_installer.sh	configuration script tidying up	2023-02-04 13:55:36 -05:00
install.bat.in	(installer) build .whl and distribute together with the installer; install from bundled .whl by default	2023-01-28 17:39:33 -05:00
install.sh.in	this fixes an issue when the install script is called outside its directory	2023-02-03 23:50:57 -05:00
installer.py	configuration script tidying up	2023-02-04 13:55:36 -05:00
main.py	add a --find-links argument to import custom wheels	2023-02-01 19:03:15 -05:00
messages.py	highlight key elements of installer welcome message	2023-02-06 00:57:29 -05:00
readme.txt	Add python version warning from the docs	2023-02-02 19:28:49 -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/

  NOTE: At this time we do not recommend Python 3.11. We recommend 
  Version 3.10.9, which has been extensively tested with InvokeAI.
  
  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, and less than 3.11.

  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 of your choice and install the
InvokeAI application within it. 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/