Skip to content

Commit e09dd0a

Browse files
committed
docs
1 parent f7292fc commit e09dd0a

File tree

2 files changed

+31
-21
lines changed

2 files changed

+31
-21
lines changed

INSTALL.md

+3
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,9 @@ OSL requires the following dependencies or tools:
5555
* [Flex](https://github.com/westes/flex)
5656
* [GNU Bison](https://www.gnu.org/software/bison/)
5757
* [PugiXML](http://pugixml.org/)
58+
* [Partio](https://www.disneyanimation.com/technology/partio.html) --
59+
optional, but if it is not found at build time, the OSL `pointcloud`
60+
functions will not be operative.
5861

5962

6063

README.md

+28-21
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
1-
README for Open Shading Language
2-
================================
1+
<div align="center">
2+
<img src="https://github.com/imageworks/OpenShadingLanguage/blob/master/src/doc/Figures/osl-short.png" width=256 height=128>
3+
</div>
4+
5+
6+
Open Shading Language
7+
=====================
38

49
Build status:
510

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

8-
Table of contents
9-
------------------
13+
**Table of contents**
1014

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

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

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

5356

5457
How OSL is different
@@ -277,19 +280,23 @@ Films using OSL (grouped by year of release date):
277280
Lego Batman,
278281
The Great Wall,
279282
A Cure for Wellness,
280-
Logan
281-
Power Rangers
282-
Life
283-
Smurfs: The Lost Village
284-
The Fate of the Furious
283+
Logan,
284+
Power Rangers,
285+
Life,
286+
Smurfs: The Lost Village,
287+
The Fate of the Furious,
288+
Alien Covenant,
289+
Guardians of the Galaxy 2,
290+
The Mummy,
291+
Wonder Woman,
285292
...
286293

287294

288295
Building OSL
289296
------------
290297

291-
Please see the "INSTALL.md" file in the OSL distribution for instructions
292-
for building the OSL source code.
298+
Please see the [INSTALL.md](INSTALL.md) file in the OSL distribution for
299+
instructions for building the OSL source code.
293300

294301

295302
Contacts, Links, and References

0 commit comments

Comments
 (0)