Skip to content

Commit 35cc406

Browse files
committed
docs: README tweaks
1 parent aa7711a commit 35cc406

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,22 @@
66
height = "400"
77
>
88
## About
9-
A Blender add-on to create add-ons! This script will take your Geometry Node group and convert it into a legible Python script.
9+
A Blender add-on to create add-ons! This script will take your Geometry Node group and convert it into a legible Python script.
1010

1111
It automatically handles node layout, default values, sub-node groups, naming, and more!
1212

13+
I think Geometry Nodes is a powerful tool that's fairly accessible to people, and I wanted to create a lightweight, faster way of distributing them than just passing around blend files. It also makes scripting Geometry Nodes easier for add-on creators in cases when Python is needed, as you don't need to recreate the whole node tree from scratch just to add in functionality like a `for` loop or interfacing with other parts of the software.
14+
1315
## Installation and Usage
14-
Simply download `node_to_python.py`, and install it to Blender like other add-ons. Then, go to `Object > Node to Python`, and type in the name of your node group. It will then save an add-on to the folder your blend file is stored in.
16+
Download `node_to_python.py`, and install it to Blender like other add-ons. Then, go to `Object > Node to Python`, and type in the name of your node group. It will then save an add-on to where your blend file is stored.
1517

1618
## Future
1719
* Expansion to Shader and Compositing nodes
1820
* Copy over referenced assets in the scene (Collections, Objects, Materials, Textures, etc.)
1921
* Automatically format code to be PEP8 compliant
2022

2123
## Potential Issues
22-
* This should work on Unix-like systems (macOS, Linux), but I haven't tested it on Windows yet. If you use Windows, please let me know if you encounter any issues.
24+
* This should work on Unix-like systems (macOS, Linux), but I haven't tested it on Windows yet. If you use Windows, please let me know or create an issue.
2325
* Make sure all your group inputs and outputs have different names, or it won't be able to find the appropriate sockets (this is best practice anyways!)
2426
* As of version 1.0.0, the add-on will not set default values for
2527
* Collections
@@ -28,4 +30,4 @@ Simply download `node_to_python.py`, and install it to Blender like other add-on
2830
* Objects
2931
* Textures
3032

31-
These are somewhat messier to deal with, though this may be possible in future versions.
33+
as they won't exist in every blend file. In the future, I may have the script automatically recreate these assets, espcially with materials.

0 commit comments

Comments
 (0)