Skip to content

Commit ae33065

Browse files
committed
Change plain text docs files to Markdown.
This includes CHANGES, INSTALL, LICENSE.
1 parent d3abea4 commit ae33065

5 files changed

Lines changed: 22 additions & 29 deletions

File tree

CHANGES renamed to CHANGES.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
Changes:
2-
31
Release 1.8 -- (in progress - dev) ?? 2016 (compared to 1.7)
4-
=====================================================
2+
--------------------------------------------------
53

64
Language, standard libary, and compiler changes (for shader writers):
75
* Language features:
@@ -107,7 +105,7 @@ Release 1.7.2 -- 1 Mar 2016 (compared to 1.7.1)
107105

108106

109107
Release 1.7 [1.7.1] -- 29 Jan 2016 (compared to 1.6)
110-
====================================================
108+
--------------------------------------------------
111109
Language, standard libary, and compiler changes (for shader writers):
112110
* Language features:
113111
* Support for closure arrays in shader inputs. #544 (1.7.0)
@@ -516,9 +514,9 @@ Release 1.5 (1.5.10) -- July 30, 2014 (compared to 1.4)
516514
----------------------------------------------
517515
Language, standard libary, and compiler changes (for shader writers):
518516
* New closure function for microfacet BSDFs:
519-
closure color microfacet (string distribution, normal N,
517+
closure color microfacet (string distribution, normal N,
520518
float alpha, float eta, int refract)
521-
closure color microfacet (string distribution, normal N, vector U,
519+
closure color microfacet (string distribution, normal N, vector U,
522520
float xalpha, float yalpha, float eta, int refract)
523521
These replace the growing zoo of microfacet_blah functions (using
524522
different distribution values such as "beckmann" or "ggx", as well as
@@ -558,11 +556,11 @@ API changes, new options, new ShadingSystem features (for renderer writers):
558556
SEE SECTION BELOW ON GROUP-SPECIFIC ATTRIBUTES
559557
* New ShaderGroupBegin() variant takes a text description of a shader
560558
group. (3.5.8) (#379) For example:
561-
ShaderGroupBegin ("groupname", "surface",
562-
"param float fin 3.14; " /*concatenate string*/
563-
"shader a alayer;"
564-
"shader b blayer;"
565-
"connect alayer.f_out blayer.f_in;");
559+
ShaderGroupBegin ("groupname", "surface",
560+
"param float fin 3.14; " /*concatenate string*/
561+
"shader a alayer;"
562+
"shader b blayer;"
563+
"connect alayer.f_out blayer.f_in;");
566564
* ShadingSystem methods renderer() and texturesys() retrieve the
567565
RendererServices and TextureSystem, respectively. (1.5.8)
568566
* ShadingSystem statistics output now prints the version and major
@@ -1433,6 +1431,3 @@ Release 0.5.2 - Mar 14, 2011
14331431
"smartcubic", "cubic", "linear", "closest").
14341432
* Bug fixes to getmessage() and its handling of derivatives, which includes
14351433
a slight RendererServices API change.
1436-
1437-
1438-

CMakeLists.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -609,8 +609,8 @@ set (CPACK_PACKAGE_VENDOR "Sony Pictures Imageworks")
609609
set (CPACK_PACKAGE_DESCRIPTION_SUMMARY "OpenShadingLanguage is...")
610610
set (CPACK_PACKAGE_DESCRIPTION_FILE "${PROJECT_SOURCE_DIR}/src/doc/Description.txt")
611611
set (CPACK_PACKAGE_FILE_NAME OSL-${OSL_LIBRARY_VERSION_MAJOR}.${OSL_LIBRARY_VERSION_MINOR}.${OSL_LIBRARY_VERSION_PATCH}-${platform})
612-
file (COPY "${PROJECT_SOURCE_DIR}/LICENSE" DESTINATION "${CMAKE_BINARY_DIR}")
613-
file (RENAME "${CMAKE_BINARY_DIR}/LICENSE" "${CMAKE_BINARY_DIR}/License.txt")
612+
file (COPY "${PROJECT_SOURCE_DIR}/LICENSE.md" DESTINATION "${CMAKE_BINARY_DIR}")
613+
file (RENAME "${CMAKE_BINARY_DIR}/LICENSE.md" "${CMAKE_BINARY_DIR}/License.txt")
614614
set (CPACK_RESOURCE_FILE_LICENSE "${CMAKE_BINARY_DIR}/License.txt")
615615
file (COPY "${PROJECT_SOURCE_DIR}/README.md" DESTINATION "${CMAKE_BINARY_DIR}")
616616
file (RENAME "${CMAKE_BINARY_DIR}/README.md" "${CMAKE_BINARY_DIR}/Readme.txt")

INSTALL renamed to INSTALL.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Building OSL
2-
------------
2+
============
33

44
OSL currently compiles and runs cleanly on Linux and Mac OS X. We have
55
not yet compiled it for Windows, but we believe we it should be very
@@ -20,7 +20,7 @@ Here are the steps to check out, build, and test the OSL distribution:
2020

2121
0. Install and build dependencies. You will need Boost (www.boost.org),
2222
Imath (http://openexr.com/downloads.html), and OpenImageIO
23-
(openimageio.org).
23+
(http://openimageio.org).
2424

2525
After building OpenImageIO, if you don't have it installed in a
2626
"standard" place (like /usr/include), you should set the environment
@@ -31,12 +31,12 @@ Here are the steps to check out, build, and test the OSL distribution:
3131

3232
1. Check out a copy of the source code from the Git repository:
3333

34-
git clone https://github.com/imageworks/OpenShadingLanguage.git osl
34+
git clone https://github.com/imageworks/OpenShadingLanguage.git osl
3535

3636
2. Change to the distribution directory and 'make'
3737

38-
cd osl
39-
make
38+
cd osl
39+
make
4040

4141
Note: OSL uses 'CMake' for its cross-platform build system. But for
4242
simplicity, we have made a "make wrapper" around it, so that by just
@@ -62,11 +62,8 @@ Here are the steps to check out, build, and test the OSL distribution:
6262
5. After building (and setting your library path), you can run the
6363
test suite with:
6464

65-
make test
65+
make test
6666

6767
(Note: currently all tests pass on OS X but a few tests fail on Linux
6868
strictly for floating point precision reasons, not because anything
6969
is really broken. We're working on a fix for this.)
70-
71-
72-

LICENSE renamed to LICENSE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ All Rights Reserved.
44
Redistribution and use in source and binary forms, with or without
55
modification, are permitted provided that the following conditions are
66
met:
7+
78
* Redistributions of source code must retain the above copyright
89
notice, this list of conditions and the following disclaimer.
910
* Redistributions in binary form must reproduce the above copyright
@@ -12,6 +13,7 @@ met:
1213
* Neither the name of Sony Pictures Imageworks nor the names of its
1314
contributors may be used to endorse or promote products derived from
1415
this software without specific prior written permission.
16+
1517
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1618
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1719
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

src/doc/CMakeLists.txt

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,8 @@ set (public_docs osl-languagespec.pdf)
33

44
install (FILES ${public_docs} DESTINATION doc COMPONENT documentation)
55

6-
install ( FILES "${PROJECT_SOURCE_DIR}/LICENSE"
7-
"${PROJECT_SOURCE_DIR}/INSTALL"
8-
"${PROJECT_SOURCE_DIR}/CHANGES"
6+
install ( FILES "${PROJECT_SOURCE_DIR}/LICENSE.md"
7+
"${PROJECT_SOURCE_DIR}/INSTALL.md"
8+
"${PROJECT_SOURCE_DIR}/CHANGES.md"
99
"${PROJECT_SOURCE_DIR}/README.md"
1010
DESTINATION . )
11-

0 commit comments

Comments
 (0)