diff --git a/README.md b/README.md new file mode 100644 index 0000000..fdc5731 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# ComfyUI-Calculator 🧮 + +A calculator node for ComfyUI. The calculator functions entirely within the UI, allowing you to perform quick calculations without needing to queue your workflow. + +![Calculator Preview](https://github.com/BobRandomNumber/ComfyUI-Calculator/blob/main/assets/Calculator.png) + +## Features + +- **Interactive UI**: Clickable buttons for digits, basic operators, and decimal points. +- **Formula View**: Displays your full mathematical expression as you type. +- **Real-time Results**: Hit `=` to instantly see the result. +- **Zero-Input/Output**: Designed as a standalone utility tool for your ComfyUI canvas. + +## Installation + +1. Navigate to your ComfyUI installation's `custom_nodes` directory. + + ```bash + cd ComfyUI/custom_nodes + ``` +2. Clone this repository or copy the `ComfyUI-Calculator` folder into it: + + ```bash + git clone https://github.com/BobRandomNumber/ComfyUI-Calculator.git + ``` +3. Restart ComfyUI. + +## Usage + +- Find the node in the search menu or under the **Calculator 🧮** category. +- Simply click the buttons on the node to perform calculations. +- Use the **C** button to clear the display at any time. \ No newline at end of file