Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lgritz committed Jun 5, 2017
1 parent f7292fc commit de2ff71
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 21 deletions.
3 changes: 3 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,9 @@ OSL requires the following dependencies or tools:
* [Flex](https://github.com/westes/flex)
* [GNU Bison](https://www.gnu.org/software/bison/)
* [PugiXML](http://pugixml.org/)
* [Partio](https://www.disneyanimation.com/technology/partio.html) --
optional, but if it is not found at build time, the OSL `pointcloud`
functions will not be operative.



Expand Down
49 changes: 28 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
README for Open Shading Language
================================
<div align="center">
<img src="https://github.com/imageworks/OpenShadingLanguage/blob/src/doc/Figures/osl-short.png" width=256 height=128>
</div>


Open Shading Language
=====================

Build status:

[![Build Status](https://travis-ci.org/imageworks/OpenShadingLanguage.svg?branch=master)](https://travis-ci.org/imageworks/OpenShadingLanguage)

Table of contents
------------------
**Table of contents**

* [Introduction](#introduction)
* [How OSL is different](#how-osl-is-different)
Expand All @@ -31,24 +35,23 @@ house renderer used for feature film animation and visual effects, released
as open source so it could be used by other visual effects and animation
studios and rendering software vendors. Now it's the de facto standard
shading language for VFX and animated features, used across the industry in
many commercial and studio- proprietary renderers. Because of this, its
designer won an Academy Award for Technical Achievement in 2017, for the
work on OSL.
many commercial and studio- proprietary renderers. Because of this, the work
on OSL received an Academy Award for Technical Achievement in 2017.

OSL is robust and production-proven, and has been used in films as diverse
as "The Amazing Spider-Man," "Hotel Transylvania," "Edge of Tomorrow", "Ant
Man", "Finding Dory," and many more. OSL support is in most leading
renderers used for high-end VFX and animation work. For a full list of films
and products, see the [filmography](#where-osl-has-been-used).

The OSL code is distributed under the "New BSD" license (see the
"LICENSE" file that comes with the distribution), and the documentation
under the Creative Commons Attribution 3.0 Unported License
(http://creativecommons.org/licenses/by/3.0/). In short, you are free
to use OSL in your own applications, whether they are free or
The OSL code is distributed under the
["New BSD" license](https://github.com/imageworks/OpenShadingLanguage/blob/master/LICENSE),
and the documentation under the [Creative Commons Attribution 3.0 Unported
License](http://creativecommons.org/licenses/by/3.0/). In short, you are
free to use OSL in your own applications, whether they are free or
commercial, open or proprietary, as well as to modify the OSL code and
documentation as you desire, provided that you retain the original
copyright notices as described in the license.
documentation as you desire, provided that you retain the original copyright
notices as described in the license.


How OSL is different
Expand Down Expand Up @@ -277,19 +280,23 @@ Films using OSL (grouped by year of release date):
Lego Batman,
The Great Wall,
A Cure for Wellness,
Logan
Power Rangers
Life
Smurfs: The Lost Village
The Fate of the Furious
Logan,
Power Rangers,
Life,
Smurfs: The Lost Village,
The Fate of the Furious,
Alien Covenant,
Guardians of the Galaxy 2,
The Mummy,
Wonder Woman,
...


Building OSL
------------

Please see the "INSTALL.md" file in the OSL distribution for instructions
for building the OSL source code.
Please see the [INSTALL.md](INSTALL.md) file in the OSL distribution for
instructions for building the OSL source code.


Contacts, Links, and References
Expand Down

0 comments on commit de2ff71

Please sign in to comment.