Skip to content

Commit

Permalink
Merge pull request #1 from usdAG/develop
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
qtc-de authored Oct 21, 2022
2 parents d20e765 + 8d69106 commit 55be92b
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,16 @@ to your ``~/.bash_completion.d`` folder enables autocompletion.
During the installation, *reftool* creates a configuration file ``~/.config/reftool.ini``.
Inside this file, the path for the reference archive and some other display related options
are set. You can adjust these options to your own preferences.

In order to be useful, at least one reference archive should be available within *reftools*
reference path. The [usd-reference-archive](https://github.com/usdAG/usd-reference-archive)
is one example for a *reftool* compatible archive. You can have several different archives
within your reference path.

For a default installation, the following commands can be used to setup a reference archive:

```console
[user@host ~]$ mkdir -p ~/.local/share/reftool-archives
[user@host ~]$ cd ~/.local/share/reftool-archives
[user@host ~]$ git clone https://github.com/usdAG/usd-reference-archive
```

0 comments on commit 55be92b

Please sign in to comment.