Mirrored_Repos/InvokeAI
1
0
Fork 0
mirror of https://github.com/invoke-ai/InvokeAI synced 2024-08-30 20:32:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

documentation fixes

Browse Source
This commit is contained in:
Lincoln Stein 2022-11-12 15:14:33 +00:00
parent 66c920fc19
commit 7ad2355b1d
3 changed files with 17 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/installation/INSTALL_MANUAL.md
View File

@ -108,10 +108,10 @@ command-line completion.
=== "Windows" === "Windows"
!!! todo " Since it requires admin privileges to create links, we will use the copy (cp) command to create your `environment.yml`" !!! todo " Since it requires admin privileges to create links, we will use the copy command to create your `environment.yml`"
```cmd ```cmd
cp environments-and-requirements\environment-win-cuda.yml environment.yml copy environments-and-requirements\environment-win-cuda.yml environment.yml
``` ```
Afterwards verify that the file `environment.yml` has been created, either via the Afterwards verify that the file `environment.yml` has been created, either via the
@ -121,6 +121,8 @@ command-line completion.
dir dir
``` ```
!!! warning "Do not try to run conda on directly on the subdirectory environments file. This won't work. Instead, copy or link it to the top-level directory as shown."
6. Create the conda environment: 6. Create the conda environment:
```bash ```bash
@ -287,17 +289,19 @@ steps:
=== "Windows" === "Windows"
!!! info "since admin privileges are required to make links, so we use the copy (`cp`) command instead" !!! info "on Windows, admin privileges are required to make links, so we use the copy command instead"
```cmd ```cmd
cp environments-and-requirements\requirements-lin-win-colab-cuda.txt requirements.txt copy environments-and-requirements\requirements-lin-win-colab-cuda.txt requirements.txt
``` ```
!!! warning !!! warning
Please do not link or copy `environments-and-requirements/requirements.txt`. Please do not link or copy `environments-and-requirements/requirements-base.txt`.
This is a base requirements file that does not have the platform-specific This is a base requirements file that does not have the platform-specific
libraries. libraries. Also, be sure to link or copy the platform-specific file to
a top-level file named `requirements.txt` as shown here. Running pip on
a requirements file in a subdirectory will not work as expected.
When this is done, confirm that a file named `requirements.txt` has been When this is done, confirm that a file named `requirements.txt` has been
created in the InvokeAI root directory and that it points to the correct created in the InvokeAI root directory and that it points to the correct

5
docs/installation/index.md
View File

@ -16,6 +16,11 @@ experience and preferences.
work", don't have an interest in tinkering with it, and do not work", don't have an interest in tinkering with it, and do not
care about upgrading to unreleased experimental features. care about upgrading to unreleased experimental features.
*Note that this script has difficulty on some Macintosh machines
that have previously been used for Python development due to
conflicting development tools versions. Mac developers may wish
to try method (2) or one of the manual methods instead.
2. [Source code installer](INSTALL_SOURCE.md) 2. [Source code installer](INSTALL_SOURCE.md)
This is a script that will install InvokeAI and all its essential This is a script that will install InvokeAI and all its essential