AcademySoftwareFoundation / AcademySoftwareFoundation/OpenShadingLanguage
Beginner Repository Build Documentation
- Dominant language
- C++
- Stars
- 2.3k
- Forks
- 414
- Avg merge
- 3d 1h
- Merged PRs (30d)
- 10
Description
Add beginner/introductory focused instructions for installing any necessary libraries and building the contents of the OSL repo. This would document all the steps necessary to successfully build all the OSL repo contents.
I have a Siggraph 2025 OSL Lab submission that could be re-designed to cover this exact material, which could then be added to the repository. The lab materials could also cover the use of osltoy and/or testrender as tools for .osl shader testing and/or development.
Contributor guide
Research direction
Start by reviewing the OSL repository's current build process and the proposed Siggraph 2025 OSL Lab materials. Inventory the libraries and steps needed to build all repository contents, and decide whether osltoy and testrender are included. Done means a beginner-focused guide covers the complete build successfully and explains the relevant shader-testing tools.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100