From 764fb29aded8114984d05932c4266ea24614b932 Mon Sep 17 00:00:00 2001 From: mauwii Date: Thu, 10 Nov 2022 06:30:15 +0100 Subject: [PATCH] fix formatting in INSTALL.md --- docs/installation/INSTALL.md | 67 ++++++++++++++++++------------------ 1 file changed, 33 insertions(+), 34 deletions(-) diff --git a/docs/installation/INSTALL.md b/docs/installation/INSTALL.md index 994b575c5d..9cb65760bb 100644 --- a/docs/installation/INSTALL.md +++ b/docs/installation/INSTALL.md @@ -9,50 +9,49 @@ experience and preferences. 1. [1-click installer](INSTALL_1CLICK.md) - This is an automated shell script that will handle installation of - all dependencies for you, and is recommended for those who have - limited or no experience with the Python programming language, are - not currently interested in contributing to the project, and just want - the thing to install and run. In this version, you interact with the - web server and command-line clients through a shell script named - `invoke.sh` (Linux/Mac) or `invoke.bat` (Windows), and perform - updates using `update.sh` and `update.bat`. + This is an automated shell script that will handle installation of + all dependencies for you, and is recommended for those who have + limited or no experience with the Python programming language, are + not currently interested in contributing to the project, and just want + the thing to install and run. In this version, you interact with the + web server and command-line clients through a shell script named + `invoke.sh` (Linux/Mac) or `invoke.bat` (Windows), and perform + updates using `update.sh` and `update.bat`. 2. [Pre-compiled PIP installer](INSTALL_PCP.md) - This is a series of installer files for which all the requirements - for InvokeAI have been precompiled, thereby preventing the conflicts - that sometimes occur when an external library is changed unexpectedly. - It will leave you with an environment in which you interact directly - with the scripts for running the web and command line clients, and - you will update to new versions using standard developer commands. + This is a series of installer files for which all the requirements + for InvokeAI have been precompiled, thereby preventing the conflicts + that sometimes occur when an external library is changed unexpectedly. + It will leave you with an environment in which you interact directly + with the scripts for running the web and command line clients, and + you will update to new versions using standard developer commands. - This method is recommended for users with a bit of experience using - the `git` and `pip` tools. + This method is recommended for users with a bit of experience using + the `git` and `pip` tools. 3. [Manual Installation](INSTALL_MANUAL.md) - In this method you will manually run the commands needed to install - InvokeAI and its dependencies. We offer two recipes: one suited to - those who prefer the `conda` tool, and one suited to those who prefer - `pip` and Python virtual environments. + In this method you will manually run the commands needed to install + InvokeAI and its dependencies. We offer two recipes: one suited to + those who prefer the `conda` tool, and one suited to those who prefer + `pip` and Python virtual environments. + + This method is recommended for users who have previously used `conda` + or `pip` in the past, developers, and anyone who wishes to remain on + the cutting edge of future InvokeAI development and is willing to put + up with occasional glitches and breakage. - This method is recommended for users who have previously used `conda` - or `pip` in the past, developers, and anyone who wishes to remain on - the cutting edge of future InvokeAI development and is willing to put - up with occasional glitches and breakage. - 4. [Docker Installation](INSTALL_DOCKER.md) - We also offer a method for creating Docker containers containing - InvokeAI and its dependencies. This method is recommended for - individuals with experience with Docker containers and understand - the pluses and minuses of a container-based install. + We also offer a method for creating Docker containers containing + InvokeAI and its dependencies. This method is recommended for + individuals with experience with Docker containers and understand + the pluses and minuses of a container-based install. 5. [Jupyter Notebooks Installation](INSTALL_JUPYTER.md) - This method is suitable for running InvokeAI on a Google Colab - account. It is recommended for individuals who have previously - worked on the Colab and are comfortable with the Jupyter notebook - environment. - + This method is suitable for running InvokeAI on a Google Colab + account. It is recommended for individuals who have previously + worked on the Colab and are comfortable with the Jupyter notebook + environment.