Skip to content

Commit

Permalink
Project Description : Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael DuBelko committed Oct 23, 2018
1 parent 09c8e9c commit 6002358
Showing 1 changed file with 42 additions and 7 deletions.
49 changes: 42 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,48 @@
== Cortex ==
![Cortex](graphics/CortexLogo.svg)

The Cortex project provides a set of high quality C++ libraries and Python modules tailored for software development in the visual effects industry. Rather than producing end user tools, the project focuses on creating a reusable set of modules of use to TDs and programmers in a broad range of scenarios - allowing them to focus on the more interesting or innovative aspects of development.

To learn more, take a look at the http://vimeo.com/cortex[Cortex presentations from SIGGRAPH 2011], read a https://github.com/ImageEngine/cortex/wiki/pdfs/AnOpenSourceFrameworkForVisualEffectsSoftwareDevelopment.pdf[short introduction to Cortex], or dive straight into the https://github.com/ImageEngine/cortex/wiki/ExamplesIntroduction[code examples].
# Cortex #

== Mailing Lists ==
Cortex is a cross-application framework for computation, rendering, and file I/O that provides a set of high-quality C++ libraries and Python modules tailored for software development in the VFX industry. This project focuses on creating a set of practical and reusable modules for technical directors, CG supervisors, and programmers, freeing them to focus on innovation and new features in their software projects.

http://groups.google.com/group/cortexdev[Developer discussion]
Out of the box, Cortex has full support for the [Arnold](https://www.arnoldrenderer.com/arnold/), [Appleseed](https://appleseedhq.net), and [3Delight](https://www.3delight.com) renderers. It also has built-in integration with Maya, Houdini, and Nuke, with default user interfaces that provide for file I/O and live data manipulation. With its extensible API, Cortex’s DCC integration can be expanded to create custom tools to solve studio pipeline needs.

http://groups.google.com/group/cortexcommits[Commit notifications]
You can find out more from our [introductory paper on Cortex](https://github.com/ImageEngine/cortex/wiki/pdfs/AnOpenSourceFrameworkForVisualEffectsSoftwareDevelopment.pdf) and the [Cortex presentations at SIGGRAPH 2011](https://vimeo.com/album/5504655).

http://groups.google.com/group/cortexissues[Issue tracker notifications]
For a proof-of-concept demonstration of Cortex’s power as a framework, see [Gaffer](https://gafferhq.org), an open-source, node-based application designed for flexible scene building, rendering, and pipeline automation.

Participation in the Cortex project requires abiding by its [Code of Conduct](https://github.com/ImageEngine/cortex/blob/master/CODE_OF_CONDUCT.md).


## Download ##

Download the latest source from the [releases page](https://github.com/ImageEngine/cortex/releases).


## Mailing Lists ##

- [Developer discussion](https://groups.google.com/group/cortexdev)
- [Commit notifications](https://groups.google.com/group/cortexcommits)

## Building and Testing ##

- [Prerequisites](https://github.com/ImageEngine/cortex/wiki/Building#prerequisites)
- [Building Cortex](https://github.com/ImageEngine/cortex/wiki/Building#building)
- [Testing Cortex](https://github.com/ImageEngine/cortex/wiki/Building#testing-and-documentation)


## Questions, Troubleshooting, and Feature Requests ##

If you have any questions about developing Cortex, or feature requests, please ask on the [Cortex developer group](https://groups.google.com/group/cortexdev).


## Contributions and Bugs Reports ##

Please see the project's [Contribution Guidelines](https://github.com/ImageEngine/cortex/blob/master/CONTRIBUTING.md).


## Copyright and License ##

© 2018 Image Engine Design Inc. All rights reserved.

Distributed under the [3-Clause BSD license](https://github.com/ImageEngine/cortex/blob/master/LICENSE).

0 comments on commit 6002358

Please sign in to comment.