Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
robinjhuang committed Jan 3, 2025
1 parent 37aca5c commit 7c1ef08
Showing 1 changed file with 22 additions and 9 deletions.
31 changes: 22 additions & 9 deletions {{cookiecutter.project_slug}}/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,20 @@
# {{cookiecutter.project_name}}

## {{cookiecutter.project_short_description}}
{{cookiecutter.project_short_description}}

Get started writing custom nodes without worrying about python project setup.
> [!NOTE]
> This projected was created with a [cookiecutter](https://github.com/Comfy-Org/cookiecutter-comfy-extension) template. It helps you start writing custom nodes without worrying about the Python setup.
## Install
## Quickstart

[Install](https://docs.comfy.org/get_started) ComfyUI first. Then look up this extension in [ComfyUI-Manager](https://github.com/ltdrdata/ComfyUI-Manager). If you are installing manually, clone this repository under `ComfyUI/custom_nodes`.
1. Install [ComfyUI](https://docs.comfy.org/get_started).
1. Install [ComfyUI-Manager](https://github.com/ltdrdata/ComfyUI-Manager)
1. Look up this extension in ComfyUI-Manager. If you are installing manually, clone this repository under `ComfyUI/custom_nodes`.
1. Restart ComfyUI.

# Features

- A list of features

## Develop

Expand All @@ -21,7 +28,7 @@ pre-commit install

The `-e` flag above will result in a "live" install, in the sense that any changes you make to your node extension will automatically be picked up the next time you run ComfyUI.

## Using Github
## Publish to Github

Install Github Desktop or follow these [instructions](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) for ssh.

Expand All @@ -33,19 +40,25 @@ git commit -m "project scaffolding"
git push
```

## comfy_types
ComfyUI exposes types that are very helpful when developing custom nodes.
## Writing custom nodes

An example custom node is located in [node.py](src/{{cookiecutter.project_slug}}/nodes.py). To learn more, read the [docs](https://docs.comfy.org/essentials/custom_node_overview).

## Type Hints
ComfyUI exposes types that are very helpful when developing custom nodes.

> 💡 **Hint:** To get the types in your modern IDE, you need to add your ComfyUI directory to the include paths. This repo has a [settings.json](.vscode/settings.json) with a template that you can use. Replace the ComfyUI path with your own.
## Tests

- [build-pipeline.yml](.github/workflows/build-pipeline.yml) will run pytest and linter
This repo contains unit tests written in Pytest in the `tests/` directory. It is recommended to unit test your custom node.

- [build-pipeline.yml](.github/workflows/build-pipeline.yml) will run pytest and linter on any open PRs
- [validate.yml](.github/workflows/validate.yml) will run [node-diff](https://github.com/Comfy-Org/node-diff) to check for breaking changes

## Publishing to Registry

If you wish to share this custom node with others in the community, you can publish it to the registry. We've already auto-populated some fields in `pyproject.toml` under `tool.comfy`, but please double-check if they are correct.
If you wish to share this custom node with others in the community, you can publish it to the registry. We've already auto-populated some fields in `pyproject.toml` under `tool.comfy`, but please double-check that they are correct.

You need to make an account on https://registry.comfy.org and create an API key token.

Expand Down

0 comments on commit 7c1ef08

Please sign in to comment.