Skip to content

Commit

Permalink
Merge pull request #53 from tedwaine/win-build-info
Browse files Browse the repository at this point in the history
Update README to point to windows branch
  • Loading branch information
tedwaine authored Aug 4, 2023
2 parents f1f52cc + 7e52628 commit 38d2b07
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,20 @@

xSTUDIO is a media playback and review application designed for professionals working in the film and TV post production industries, particularly the Visual Effects and Feature Animation sectors. xSTUDIO is focused on providing an intuitive, easy to use interface with a high performance playback engine at its core and C++ and Python APIs for pipeline integration and customisation for total flexibility.

## Building xSTUDIO
## Building xSTUDIO for MS Windows

This release of xSTUDIO can be built on various Linux flavours. MacOS and Windows compatibility is not available yet but this work is on the roadmap for 2023.
You can now build and run xSTUDIO on MS Windows. However, work towards full Windows compatibility is still in its final phase and the updates are therefore not yet merged into the main branch here. To access the Windows compatible codebase please follow [this link](https://github.com/mpkepic/xstudio/tree/windows).

We provide comprehensive build steps for 3 of the most popular Linux distributions.
## Building xSTUDIO for Linux

We provide comprehensive build steps for 3 of the most popular Linux distributions:

* [CentOS 7](docs/build_guides/centos_7.md)
* [Rocky Linux 9.1](docs/build_guides/rocky_linux_9_1.md)
* [Ubuntu 22.04](docs/build_guides/ubuntu_22_04.md)

Note that the xSTUDIO user guide is built with Sphinx using the Read-The-Docs theme. The package dependencies for building the docs are somewhat onerous to install and as such we have ommitted these steps from the instructions and instead recommend that you turn off the docs build. Instead, we include the fully built docs (as html pages) as part of this repo and building xSTUDIO will install these pages so that they can be loaded into your browser via the Help menu in the main UI.

## Building xSTUDIO for MacOS

MacOS compatibility is not yet available but it is due in Q3 or Q4 2023. Watch this space!

0 comments on commit 38d2b07

Please sign in to comment.