Filling in README

README.md

@@ -1 +1,19 @@
-Nuke DAG Capture
+# Nuke DAG Capture
+
+This is a python script that allows to capture a PNG image of the Nuke node graph. 
+The first version was written as an answer to a [Stack Overflow Question](https://stackoverflow.com/questions/64674724/extract-a-vector-image-or-high-res-image-from-nukes-node-graph), but the code has since evolved a bit to include more options and a UI panel.
+
+## Usage
+
+For now the easiest way to use the script when required is to copy and paste the content of [dag_capture.py](dag_capture.py) into the Nuke script editor and execute the whole thing.
+Feel free to contact me if you want to install in a menu.py and can't figure it out yourself. 
+
+Pick a path for the desired location of the screenshot (.png format) and edit the options in the UI if necessary (defaults should work okay).
+
+![ui screenshot](screenshot.png)
+
+Then click OK and hang on while the script does its work.
+
+## Known issues
+- I have noticed that sometimes the very first tile of the screenshot is showing black with random colored pixels. I am not sure why that is the case, and usually retrying the capture fixes the issue.
+- Some node input labels move around when scrolling in the DAG, and can sometimes end up being in the screenshot multiple times, or being slightly cropped. The crop issue can be fixed by reducing the DAG preview (in lower right corner of DAG) to be invisible, and setting no right crop in the capture settings. Once the dag preview is entirely collapsed, I am not sure how to bring it back apart from restarting nuke.