Skip to content

Commit

Permalink
Update documentation on the Nuke environment var
Browse files Browse the repository at this point in the history
Signed-off-by: Alex Hughes <[email protected]>
  • Loading branch information
Ahuge committed Dec 2, 2024
1 parent aafb022 commit 2351ff5
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
2 changes: 1 addition & 1 deletion DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,6 @@ You can run the adaptor on your local workstation. This approach does not contai
nuke-openjd run --init-data file://init-data.yaml --run-data file://run-data.yaml --path-mapping-rules file://path-mapping.yaml
```

NOTE: The nuke-openjd binary expects that the Nuke executable is named `nuke` and is set on the PATH. If this is not the case, you can set the `NUKE_ADAPTOR_NUKE_EXECUTABLE` environment variable to the path to the Nuke executable.
NOTE: The nuke-openjd binary expects that the Nuke executable is named `nuke` and is set on the PATH. If this is not the case, you can set the `NUKE_EXECUTABLE` environment variable to the path to the Nuke executable.

4. The result will be written based on the output specified on the write node, taking any path mapping into account.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,10 @@ The Nuke Adaptor implements the [OpenJD][openjd-adaptor-runtime] interface that
* sticky rendering, where the application stays open between tasks,
* path mapping, that enables cross-platform rendering

Jobs created by the submitter use this adaptor by default.
Jobs created by the submitter use this adaptor by default, and that both the installed adaptor
and the Nuke executable be available on the PATH of the user that will be running your jobs.

Or you can set the `NUKE_EXECUTABLE` to point to the Nuke executable.

### Getting Started

Expand All @@ -49,13 +52,13 @@ For more information on the commands the OpenJD adaptor runtime provides, see [h

## Versioning

This package's version follows [Semantic Versioning 2.0](https://semver.org/), but is still considered to be in its
This package's version follows [Semantic Versioning 2.0](https://semver.org/), but is still considered to be in its
initial development, thus backwards incompatible versions are denoted by minor version bumps. To help illustrate how
versions will increment during this initial development stage, they are described below:

1. The MAJOR version is currently 0, indicating initial development.
2. The MINOR version is currently incremented when backwards incompatible changes are introduced to the public API.
3. The PATCH version is currently incremented when bug fixes or backwards compatible changes are introduced to the public API.
1. The MAJOR version is currently 0, indicating initial development.
2. The MINOR version is currently incremented when backwards incompatible changes are introduced to the public API.
3. The PATCH version is currently incremented when bug fixes or backwards compatible changes are introduced to the public API.

## Security

Expand Down

0 comments on commit 2351ff5

Please sign in to comment.