diff --git a/docs/installation/020_INSTALL_MANUAL.md b/docs/installation/020_INSTALL_MANUAL.md index e96cbc51ed..3b35f18dbc 100644 --- a/docs/installation/020_INSTALL_MANUAL.md +++ b/docs/installation/020_INSTALL_MANUAL.md @@ -37,8 +37,18 @@ manager, please follow these steps: ```bash python -V ``` + +2. Clone the [InvokeAI](https://github.com/invoke-ai/InvokeAI) source code from + GitHub: -2. From within the InvokeAI top-level directory, create and activate a virtual + ```bash + git clone https://github.com/invoke-ai/InvokeAI.git + ``` + + This will create InvokeAI folder where you will follow the rest of the + steps. + +3. From within the InvokeAI top-level directory, create and activate a virtual environment named `invokeai`: ```bash @@ -46,14 +56,14 @@ manager, please follow these steps: source invokeai/bin/activate ``` -3. Make sure that pip is installed in your virtual environment an up to date: +4. Make sure that pip is installed in your virtual environment an up to date: ```bash python -mensurepip --upgrade python -mpip install --upgrade pip ``` -4. Pick the correct `requirements*.txt` file for your hardware and operating +5. Pick the correct `requirements*.txt` file for your hardware and operating system. We have created a series of environment files suited for different operating @@ -106,7 +116,7 @@ manager, please follow these steps: created in the InvokeAI root directory and that it points to the correct file in `environments-and-requirements`. -5. Run PIP +6. Run PIP Be sure that the `invokeai` environment is active before doing this: @@ -114,7 +124,7 @@ manager, please follow these steps: pip install --prefer-binary -r requirements.txt ``` -6. Set up the runtime directory +7. Set up the runtime directory In this step you will initialize a runtime directory that will contain the models, model config files, directory for textual @@ -153,7 +163,7 @@ manager, please follow these steps: prompted) and configure InvokeAI to use the previously-downloaded files. The process for this is described in [here](050_INSTALLING_MODELS.md). -7. Run the command-line- or the web- interface: +8. Run the command-line- or the web- interface: Activate the environment (with `source invokeai/bin/activate`), and then run the script `invoke.py`. If you selected a non-default location @@ -189,7 +199,7 @@ manager, please follow these steps: You can permanently set the location of the runtime directory by setting the environment variable INVOKEAI_ROOT to the path of the directory. -8. Render away! +9. Render away! Browse the [features](../features/CLI.md) section to learn about all the things you can do with InvokeAI. @@ -199,7 +209,7 @@ manager, please follow these steps: time you try to generate an image. Fortunately, after the warm up period rendering will be fast. -9. Subsequently, to relaunch the script, be sure to run "conda activate +10. Subsequently, to relaunch the script, be sure to run "conda activate invokeai", enter the `InvokeAI` directory, and then launch the invoke script. If you forget to activate the 'invokeai' environment, the script will fail with multiple `ModuleNotFound` errors.