Cat-Lips / GodotSharp.SourceGenerators

C# source generators for the Godot Game Engine
MIT License
112 stars 10 forks source link

Improve README readability by adding sample code. #54

Closed qwe321qwe321qwe321 closed 5 months ago

qwe321qwe321qwe321 commented 5 months ago

Hello, Unity refugee here. I was looking for a better experience for C# scripting with strongly typed design and found this amazing plugin.

I love how you utilize Source Generator to make life so much easier. (I hate that there is so much string based design in Godot.)

So I really appreciate what you have done here.

However, it is a shame that README is not clear enough to know how to use them.

It took me about a day to test and know exactly what and how the attributes do. And there are still some parameters that I don't know what they mean.

I don't know if you would like to add more friendly README, but anyway, I added the section at the end to include sample code for attributes that I know how to use.

It's not perfect but now I can easily know how to use them instead of having to open the test project and figure it out.

Especially for the Godot beginners like me.

Cat-Lips commented 5 months ago

Hey, thanks for that. Nice work. :)