apextoaster
/
onnx-web
1
0
Fork 0
Code Actions

fix(docs): note python3 command and venv "name cmd" error in readme

This commit is contained in:
Sean Sube 2023-01-08 00:31:27 -06:00
parent a6af9752f8
commit f119cb4100
1 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -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 Python installed for another form of Stable Diffusion, that should work, but make sure to verify the version in the next
step. 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: Once you have those basic packages installed, clone this git repository:
```shell ```shell
@ -105,12 +114,9 @@ Once you have those basic packages installed, clone this git repository:
### Create a virtual environment ### 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 ```shell
> python --version
Python 3.10
> pip install virtualenv > pip install virtualenv
> python -m venv onnx_env > python -m venv onnx_env
@ -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 This will contain all of the pip libraries. If you update or reinstall Python, you will need to recreate the virtual
environment. 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/debian-bugs-dist@lists.debian.org/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: Every time you start using ONNX web, activate the virtual environment:
```shell ```shell