Skip to content

Commit

Permalink
Add uv instructions to README.
Browse files Browse the repository at this point in the history
  • Loading branch information
robinjhuang committed Nov 12, 2024
1 parent db43ae3 commit 441141c
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,6 @@ This will install a usable `yarn` binary. Then, in the root directory of this re
yarn install
```

Start the development server:

```bash
yarn start
```

## Setup Python

Make sure you have python 3.12+ installed. It is recommended to setup a virtual environment to run the python code.
Expand All @@ -83,7 +77,7 @@ With the python environment activated, install comfy-cli:
pip install comfy-cli
```

## Building/running
## Building/Running

First, initialize the application resources by running `make:assets:<gpu>`:

Expand All @@ -92,7 +86,11 @@ First, initialize the application resources by running `make:assets:<gpu>`:
yarn make:assets:[amd|cpu|nvidia|macos]
```

This command will install ComfyUI under `assets`, as well ComfyUI-Manager, and the frontend [extension](https://github.com/Comfy-Org/DesktopSettingsExtension) responsible for electron settings menu.
This command will install ComfyUI under `assets`, as well ComfyUI-Manager, and the frontend [extension](https://github.com/Comfy-Org/DesktopSettingsExtension) responsible for electron settings menu. The exact versions of each package is defined in `package.json`.

Second, you need to install `uv`. This will be bundled with the distributable, but we also need it locally.

`yarn download:uv`

You can then run `start` to build/launch the code and a live buildserver that will automatically rebuild the code on any changes:

Expand Down

0 comments on commit 441141c

Please sign in to comment.