Skip to content

Commit 0a5cc54

Browse files
Documentation updates (#49)
Signed-off-by: Darby Johnston <darbyjohnston@yahoo.com>
1 parent 264fb38 commit 0a5cc54

2 files changed

Lines changed: 117 additions & 16 deletions

File tree

README.md

Lines changed: 37 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
[![Build Status](https://github.com/OpenTimelineIO/toucan/actions/workflows/ci-workflow.yml/badge.svg)](https://github.com/OpenTimelineIO/toucan/actions/workflows/ci-workflow.yml)
22

3-
<img src="images/toucan.svg" alt="toucan" width="64">
3+
# ![DJV Icon](images/toucan_64.svg) Toucan
44

5-
6-
Toucan
7-
======
85
Toucan is a software renderer for OpenTimelineIO files. Toucan can render an
96
OpenTimelineIO file with multiple tracks, clips, transitions, and effects
107
into an image sequence or movie file.
@@ -39,8 +36,8 @@ Toucan relies on the following libraries:
3936
Supported VFX platforms: 2024, 2023, 2022
4037

4138

42-
Example Renders
43-
===============
39+
## Example Renders
40+
4441
Compositing multiple tracks:
4542

4643
![CompositeTracks](images/CompositeTracks.png)
@@ -90,8 +87,8 @@ Multiple effects on clips, tracks, and stacks:
9087
![Track Effects](images/MultipleEffects.png)
9188

9289

93-
FFmpeg Encoding
94-
===============
90+
## FFmpeg Encoding
91+
9592
Toucan can write movies with FFmpeg directly, or send raw images to the FFmpeg
9693
command line program over a pipe.
9794

@@ -133,11 +130,23 @@ can be found by running `toucan-render` with the `-print_size` option.
133130
* `output.mov`: The output movie file.
134131

135132

136-
Building
137-
========
133+
## Building
134+
135+
### Building on Linux
136+
137+
Dependencies:
138+
* CMake 3.31
139+
140+
Install system packages (Debian based systems):
141+
```
142+
sudo apt-get install xorg-dev libglu1-mesa-dev mesa-common-dev mesa-utils
143+
```
144+
145+
Install system packages (Rocky 9):
146+
```
147+
sudo dnf install libX11-devel libXrandr-devel libXinerama-devel libXcursor-devel libXi-devel mesa-libGL-devel
148+
```
138149

139-
Building on Linux
140-
-----------------
141150
Clone the repository:
142151
```
143152
git clone https://github.com/OpenTimelineIO/toucan.git
@@ -154,8 +163,12 @@ export LD_LIBRARY_PATH=$PWD/install-Release/lib:$LD_LIBRARY_PATH
154163
install-Release/bin/toucan-view toucan/data/Transition.otio
155164
```
156165

157-
Building on macOS
158-
-----------------
166+
### Building on macOS
167+
168+
Dependencies:
169+
* Xcode
170+
* CMake 3.31
171+
159172
Clone the repository:
160173
```
161174
git clone https://github.com/OpenTimelineIO/toucan.git
@@ -169,8 +182,16 @@ Run the viewer application:
169182
install-Release/bin/toucan-view toucan/data/Transition.otio
170183
```
171184

172-
Building on Windows
173-
-------------------
185+
### Building on Windows
186+
187+
Dependencies:
188+
* Visual Studio 2022
189+
* CMake 3.31
190+
* MSYS2 (https://www.msys2.org) for compiling FFmpeg.
191+
192+
Open the Visual Studio command console "x64 Native Tools Command Prompt for VS 2022".
193+
This can be found in the Start menu, in the "Visual Studio 2022" folder.
194+
174195
Clone the repository:
175196
```
176197
git clone https://github.com/OpenTimelineIO/toucan.git

images/toucan_64.svg

Lines changed: 80 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)