Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: fix README typos #203

Merged
merged 1 commit into from
Dec 10, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![python](https://img.shields.io/pypi/pyversions/deadline-cloud-for-maya.svg?style=flat)](https://pypi.python.org/pypi/deadline-cloud-for-maya)
[![license](https://img.shields.io/pypi/l/deadline-cloud-for-maya.svg?style=flat)](https://github.com/aws-deadline/deadline-cloud-for-maya/blob/mainline/LICENSE)

AWS Deadline Cloud for Maya is a Python package that supports creating and running Audodesk Maya jobs within [AWS Deadline Cloud][deadline-cloud].
AWS Deadline Cloud for Maya is a Python package that supports creating and running Autodesk Maya jobs within [AWS Deadline Cloud][deadline-cloud].
It provides both the implementation of a Maya plug-in for your workstation that helps you offload the computation for your rendering workloads
to [AWS Deadline Cloud][deadline-cloud] to free up your workstation's compute for other tasks, and the implementation of a command-line
adaptor application based on the [Open Job Description (OpenJD) Adaptor Runtime][openjd-adaptor-runtime] that improves AWS Deadline Cloud's
Expand Down Expand Up @@ -52,7 +52,7 @@ scene to your farm to ensure that your setup is correctly functioning.
The Maya submitter plug-in creates a shelf button in your Maya UI that can be used to submit jobs to AWS Deadline Cloud. Clicking this button
reveals a UI to create a job submission for AWS Deadline Cloud using the [AWS Deadline Cloud client library][deadline-cloud-client].
It automatically determines the files required based on the loaded scene, allows the user to specify render options, builds an
[Open Job Description template][openjd] that defines the workflow, and submits the job to the farm and queue of your chosing.
[Open Job Description template][openjd] that defines the workflow, and submits the job to the farm and queue of your choosing.

To install the submitter plug-in:

Expand All @@ -63,7 +63,7 @@ To install the submitter plug-in:
from the release branch of [deadline-cloud-for-maya GitHub repository](https://github.com/aws-deadline/deadline-cloud-for-maya) into
a directory in Maya's module search paths. See the `MAYA_MODULE_PATH` section of Maya's official documentation
(e.g. [For Maya 2024][maya-2024-module-path]) for a list of the default search paths on your system.
3. Within Maya, enable the DealineCloudForMaya plug-in in Maya's Plug-in Manager.
3. Within Maya, enable the DeadlineCloudForMaya plug-in in Maya's Plug-in Manager.
(Main menu bar: Windows -> Settings/Preferences -> Plug-in Manager)
4. To supply AWS account credentials for the submitter to use when submitting a job you can either:
1. [Install and set up the Deadline Cloud Monitor][deadline-cloud-monitor-setup], and then log in to the monitor. Logging in
Expand Down Expand Up @@ -118,7 +118,7 @@ hosts do not have any rendering applications pre-installed. The standard way of
[in the service documentation](https://docs.aws.amazon.com/deadline-cloud/latest/developerguide/provide-applications.html).
You can find a list of the versions of Maya that are available by default
[in the user guide](https://docs.aws.amazon.com/deadline-cloud/latest/userguide/create-queue-environment.html#conda-queue-environment)
if you are using the default Conda queue enivonment in your setup.
if you are using the default Conda queue environment in your setup.

## Viewing the Job Bundle that will be submitted

Expand Down
Loading