Skip to content

Commit eb52aa1

Browse files
authored
add simple Docker docs (#495)
1 parent 9ed59ef commit eb52aa1

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

docs/developers/getting_started.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,33 @@ working fork::
6161
You should then do a git fetch, and git merge (detailed below) to download the
6262
remote branches you've just added.
6363

64+
Reference Build Environment
65+
***************************
66+
67+
To aid new developers to the project and provide a baseline standard,
68+
OCIO provides a reference build environment through Docker. Docker essentially is a
69+
container that consits of both a Linux distro and the dependencies needed to run
70+
a client application. This is typically used for deploying apps and services to
71+
servers, but we are using it to provide an isolated development environment to build
72+
and test OCIO with. With this environment you are guaranteed to be able to compile OCIO
73+
and run its non-GUI command line applications.
74+
75+
For more information on Docker, start here:
76+
https://docs.docker.com/engine/docker-overview/
77+
78+
In order to run the Docker environment you will have to build it from the Dockerfile
79+
provided in the repo directory::
80+
81+
OpenColorIO/shared/docker
82+
83+
Run this command in order to build the Docker image (aprox. 20min)::
84+
85+
docker build . -t ocio:centos7_gcc48 -f dockerfile_centos7_gcc48
86+
87+
You can then mount the current OCIO directory and compile using the Docker image with::
88+
89+
docker run --volume $PWD/../../:/src/ociosrc -t ocio:centos7_gcc48 bash -c 'mkdir /build && cd /build && cmake /src/ociosrc && make -j2`
90+
6491

6592
Merging changes
6693
***************

0 commit comments

Comments
 (0)