Skip to content

Commit

Permalink
fix(docs): note python3 command and venv "name cmd" error in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ssube committed Jan 8, 2023
1 parent a6af975 commit f119cb4
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,15 @@ The latest version of git should be fine. Python must be 3.10 or earlier, 3.10 s
Python installed for another form of Stable Diffusion, that should work, but make sure to verify the version in the next
step.

Make sure you have Python 3.10 or earlier:

```shell
> python --version
Python 3.10
```

If your system uses `python3` and `pip3` for the Python 3.x tools, make sure to adjust the commands shown here.

Once you have those basic packages installed, clone this git repository:

```shell
Expand All @@ -105,12 +114,9 @@ Once you have those basic packages installed, clone this git repository:

### Create a virtual environment

Make sure you have Python 3.10 or earlier, change into the then create a virtual environment:
Change into the `api/` directory, then create a virtual environment:

```shell
> python --version
Python 3.10

> pip install virtualenv

> python -m venv onnx_env
Expand All @@ -119,6 +125,13 @@ Python 3.10
This will contain all of the pip libraries. If you update or reinstall Python, you will need to recreate the virtual
environment.

If you receive an error like `Error: name 'cmd' is not defined`, there may be [a bug in the `venv` module](https://www.mail-archive.com/[email protected]/msg1884072.html) on certain
Debian-based systems. You may need to install venv through apt instead:

```shell
> sudo apt install python3-venv # only if you get an error
```

Every time you start using ONNX web, activate the virtual environment:

```shell
Expand Down

0 comments on commit f119cb4

Please sign in to comment.