Merge pull request #2 from liusida/dev

README write up
2024-04-07 19:33:01 +08:00
parent 1967284553 ae1635e84b
commit f0341a57f9
2 changed files with 16 additions and 1 deletions
@@ -1,2 +1,17 @@
 # ComfyUI-Debug
-Attach a debug node to an output to get more information.
+
+Attach a debug node to an output to obtain more detailed information.
+
+If you are like me, knowing more about the details of the models is beneficial. Here, I present two custom nodes for [ComfyUI](https://github.com/comfyanonymous/ComfyUI):
+
+![screenshot](imgs/node_model_metrics_and_model_architecture.png)
+
+# How to Install
+
+1. Git clone this repository into the `ComfyUI/custom_nodes/` directory, then restart ComfyUI, or
+
+2. Use [ComfyUI-Manager](https://github.com/ltdrdata/ComfyUI-Manager), navigate to `Install Custom Nodes`, search for `debug`, and install it.
+
+# Tell Us What Kind of Debug Information You Need
+
+Are you also curious about CLIP and VAE? We are working on those as well. What other information would you like us to include? Feel free to open an issue – your contributions are more than welcome!