Skip to content

Commit

Permalink
Merge pull request #47 from tokejepsen/update_docs
Browse files Browse the repository at this point in the history
Update docs about overrides.
  • Loading branch information
tokejepsen authored Jul 19, 2018
2 parents 7377018 + 4764718 commit be912ba
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,27 @@ docker run --name avalon-files -d --rm \

See the [Usage](#usage) instructions, though you may want to remove `-d` and `-ti` so as to witness logs and more easily kill containers.

#### Override modules

When developing on individual repositories like Avalon-core or Avalon-launcher, it can be useful to have separate repositories from the submodules of Avalon-docker.
You can still utilize Avalon-docker for testing by using environment variables to override where Avalon-docker looks for the modules.

```bash
$ git clone https://github.com/getavalon/core.git avalon-core
$ set AVALON_CORE=%cd%\avalon-core
$ # Launch Avalon, using this repo for the core
$ avalon
```

The available environment variables are:

| Environment Variable | Description
|---|---
| ```AVALON_CORE``` | Override Avalon core module; https://github.com/getavalon/core
| ```AVALON_LAUNCHER``` | Override Avalon launcher module; https://github.com/getavalon/launcher
| ```PYBLISH_BASE``` | Override Pyblish base module; https://github.com/pyblish/pyblish-base
| ```PYBLISH_QML``` | Override Pyblish qml module; https://github.com/pyblish/pyblish-qml

#### Testing

From `terminal.bat` run nose like so.
Expand Down

0 comments on commit be912ba

Please sign in to comment.