search

unity-sds / unity-py

Apache License 2.0
2 stars 3 forks source link

Added missing files and improved README #55

Closed riverma closed 11 months ago

riverma commented 1 year ago

Purpose

riverma commented 1 year ago

Note @anilnatha: please add a screenshot of the unity.py tool to the README in the top [INSERT SCREENSHOT... line mentioned here: https://github.com/riverma/unity-py/blame/rverma-patch-1/README.md#L16

rtapella commented 1 year ago

@riverma for libraries like this… what do you suggest for a screenshot? The pypi web page for unity-sds-client? A screenshot of python code that uses the library? A screenshot of the library code itself? Something else?

riverma commented 1 year ago

@riverma for libraries like this… what do you suggest for a screenshot? The pypi web page for unity-sds-client? A screenshot of python code that uses the library? A screenshot of the library code itself? Something else?

Hi @rtapella - thanks for that. Since this is a user-interface of sorts, I was thinking it would be useful to have a screenshot (or GIF!) of say a terminal window and some sample commands in action. Doing so would quickly communicate the utility of using unity-py. What do you think?

anilnatha commented 1 year ago

@rtapella we spoke of adding code samples in lieu of screenshots, if you're still good with that let me know so that I can remove the placeholder screenshot callout, before approving and merging this PR.

riverma commented 1 year ago

@rtapella we spoke of adding code samples in lieu of screenshots, if you're still good with that let me know so that I can remove the placeholder screenshot callout, before approving and merging this PR.

@anilnatha @rtapella - code samples in place of screens is great, probably more useful given the nature of the unity-py tool. LGTM!