Skip to content

Commit 77771bc

Browse files
authored
Merge branch 'main' into rh-uv2
2 parents dbe50da + 56740af commit 77771bc

File tree

1 file changed

+26
-8
lines changed

1 file changed

+26
-8
lines changed

README.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ on Windows: %USERPROFILE%\AppData\Roaming\{app name}\logs\main.log
3535

3636
# Development
3737

38-
## Setup Yarn
38+
## Local Server
3939

4040
This project uses `yarn` as its package manager. If you do not already have a `yarn` binary available on your PATH, run:
4141

@@ -51,6 +51,12 @@ This will install a usable `yarn` binary. Then, in the root directory of this re
5151
yarn install
5252
```
5353

54+
Start the development server:
55+
56+
```bash
57+
yarn start
58+
```
59+
5460
## Setup Python
5561

5662
Make sure you have python 3.12+ installed. It is recommended to setup a virtual environment to run the python code.
@@ -94,16 +100,28 @@ You can then run `start` to build/launch the code and a live buildserver that wi
94100
yarn start
95101
```
96102

97-
You can also build the package and/or distributables using the `package` and `make` commands:
103+
You can also build the package and/or distributables using the `make` command:
98104

99105
```bash
100-
# build the platform-dependent package
101-
yarn package
106+
# build the platform-dependent package and any distributables
107+
yarn make
102108
```
103109

110+
# Release
111+
112+
We use Todesktop to build and codesign our releases. To make a new release:
113+
114+
1. Make a PR titled "v<semantic version>"
115+
2. Add the label "Release" (case sensitive)
116+
3. Merge the PR
117+
4. A build will automatically start and you can view it at https://app.todesktop.com
118+
119+
120+
### Publish Locally
121+
104122
```bash
105-
# build the platform-dependent package and any distributables
106-
yarn make
123+
# Authentication will be required.
124+
yarn publish
107125
```
108126

109127
## Utility scripts
@@ -121,8 +139,8 @@ yarn clean:slate
121139

122140
## Windows
123141

124-
x64 [Download](https://updater.comfy.org/windows/latest)
142+
x64 [Download](https://download.comfy.org/windows/nsis/x64)
125143

126144
## Mac
127145

128-
ARM64 [Download](https://updater.comfy.org/darwin/latest)
146+
ARM64 [Download]()

0 commit comments

Comments
 (0)