Skip to content

Commit 48a0c79

Browse files
committed
Other: Documentation update.
1 parent c28c241 commit 48a0c79

File tree

4 files changed

+9
-0
lines changed

4 files changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ GLSL Shader Shrink will _not_:
2828
* Replace code with a 'more compressible' equivalent.
2929
* ...or otherwise '[GOLF](https://en.wikipedia.org/wiki/Code_golf)' anything.
3030

31+
...although some of these items might be suggested as a 'hint'.
32+
3133
## Example (Shadertoy Starting Point)
3234
A small snippet of GLSL which shows **some** of the optimizations available.
3335

@@ -98,6 +100,13 @@ This can be achieved using:
98100

99101
...and then use with Shadertoy, Bonzomatic, etc.
100102

103+
---
104+
## Hints
105+
After shrinking your GLSL code, you might find some 'hints' are available.
106+
These range from 'this function isn't used' or 'this function is only used once, so you might like to inline it', all the way to some GOLFing hints.
107+
108+
![Export](img/Hints.png?raw=true "Export")
109+
101110
---
102111
## Limitations
103112
Despite a lot of effort spent trying to ensure the tool produces great output every time, there are always going to be edge cases caused by different coding styles and patterns of content.

img/ED209.png

11.1 KB
Loading

img/Export.png

1.71 KB
Loading

img/Hints.png

117 KB
Loading

0 commit comments

Comments
 (0)