search

MitjaNemec / PlaceFootprints

GNU General Public License v2.0
25 stars 5 forks source link

initial readme #7

Closed MATTERealise closed 2 years ago

MATTERealise commented 2 years ago

hey, its Simon. Sorry it's taking so long for me to add the docs. Hopefully this will be enough readme to get people started. The links to the gifs should work once it is in your branch (but don't in mine because the links would be wrong). I'm new to most of the version control stuff so please explain if I need to do anything differently.

MitjaNemec commented 2 years ago

Thanks for your contribution. I've also slightly updated the readme with installation instructions and a brief mention of additional feature. And this is a perfect example why maintaining the documentation is a real PITA. Given that I've managed to update the plugin recently (#3) the graphics you've made should be updated. And I know that preparing the graphics really takes a lot of time and effort.

Now, don't get me wrong. I don't think that updating the graphics is critical. I'd defer it for a couple of months as I expect the plugin might be updated in the near future. Since V6 with PCM, plugins have much better discoverability, so I expect more users will try them out and propose new features and/or find more bugs

SimonMerrett commented 2 years ago

Darn, I updated the plugin just before making the graphics last night! I thought I saw the rotate every nth component but I guess not the way #3 implements.

I'll move on to another repo next. Do you think Replicate Layout is ready? It was buggy for me earlier this week. Or do you have a higher priority?

MitjaNemec commented 2 years ago

Regarding the Replicate Layout, what was buggy? I did receive a couple of issues, but critical ones should have been resolved.

If you have reservations you might want to start on Archive 3D Models.

Also with regards to documentation, obviously a README.md is a must, but that can bi minimal. I can give you write acces to the repository and you could add/edit wiki. Might be closer to your preferred workflow.

MitjaNemec commented 2 years ago

Also, you might want to look at the description and description_full fields in metadata_source.json for all the plugins. This text shows in the PCM