aws-deadline / deadline-cloud-for-cinema-4d

AWS Deadline Cloud for Cinema 4D
Apache License 2.0
9 stars 12 forks source link

docs: Update the documentation for the repo. #87

Closed karthikbekalp closed 1 week ago

karthikbekalp commented 1 week ago

What was the problem/requirement? (What/Why)

Our documentation for this repo was not good enough for easy onboarding for customers.

What was the solution? (How)

Hence, updated the documentation accordingly. This PR is inspired mostly from a similar change in the Maya Github repo for deadline cloud : https://github.com/aws-deadline/deadline-cloud-for-maya/pull/173

This also adds submitter installation instructions for Mac OS. https://github.com/aws-deadline/deadline-cloud-for-cinema-4d/issues/61

What is the impact of this change?

Better onboarding steps for customers. Mainly moved the contents of DEVELOPMENT.md to README.md as customers onboarding shouldn't have to deep dive into the DEVELOPMENT.md page.

We will update DEVELOPMENT page in a follow up PR but for now we want to make the README page with clear instructions to follow.

How was this change tested?

This was based off of my personal notes that helped me onboard to Cinema 4D easily.

Was this change documented?

Yes

Is this a breaking change?

No

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

sonarcloud[bot] commented 1 week ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud