Skip to content

Commit

Permalink
chore: update README.md with follow-able command (#167)
Browse files Browse the repository at this point in the history
* chore: update README.md with follow-able command

Signed-off-by: Haejung Choi <chaejung@amazon.com>

---------

Signed-off-by: Haejung Choi <chaejung@amazon.com>
Co-authored-by: Haejung Choi <chaejung@amazon.com>
  • Loading branch information
diane-hj and Haejung Choi authored Sep 18, 2024
1 parent 82b7eb2 commit 5eea0a8
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,22 +28,31 @@ This package provides a Nuke plugin that creates jobs for AWS Deadline Cloud usi

To install the submitter manually, you can use pip.

For Windows,
```sh
pip install deadline-cloud-for-nuke -t %USERPROFILE%/deadline-cloud-for-nuke
```

For Linux and MacOS:
```sh
$ pip install deadline-cloud-for-nuke -t target-directory
pip install deadline-cloud-for-nuke -t ~/deadline-cloud-for-nuke
```
Please note that target directory is `~/deadline-cloud-for-nuke` in Mac/Linux or `C:\Users\username/deadline-cloud-for-nuke` in Windows in the example, but you can choose any other directories that you'd prefer.

For Windows,
```sh
$ set NUKE_PATH=%NUKE_PATH%;<target-directory>/deadline/nuke_submitter
set NUKE_PATH=%NUKE_PATH%;%USERPROFILE%/deadline-cloud-for-nuke/deadline/nuke_submitter
```

For Linux and MacOS:
```sh
$ export NUKE_PATH=${NUKE_PATH}:<target-directory>/deadline/nuke_submitter
export NUKE_PATH=${NUKE_PATH}:~/deadline-cloud-for-nuke/deadline/nuke_submitter
```

After installation and within the same terminal, run `Nuke<version>` executable. The Nuke submitter should now be available in the AWS Deadline menu.

For Mac, Nuke executable will be somewhere in `/Applications/Nuke15.0v4/Nuke15.0v4.app/Contents/MacOS` directory.

NOTE: If you want the submitter available outside of this shell, consider using `NUKE_PATH` as an environment variable rather than a shell variable.

## Adaptor
Expand Down

0 comments on commit 5eea0a8

Please sign in to comment.