gkjohnson / three-gpu-pathtracer

Path tracing renderer and utilities for three.js built on top of three-mesh-bvh.
https://gkjohnson.github.io/three-gpu-pathtracer/example/bundle/index.html
MIT License
1.27k stars 125 forks source link

Index in README #638

Closed JaimeTorrealba closed 1 month ago

JaimeTorrealba commented 1 month ago

Since the README is long it might be useful to have a simple index, so every time someone needs a component, for example, doesn't need to scroll

As I'm new here, I come with something like:

image

A simple table with the proper links, Now if you like we can add titles or other sections. This could be handy for the other siblings projects (like bvh/csg)

If you like, I will open the PR here (later in other pkg)

gkjohnson commented 1 month ago

Thanks for the recommendation. There's a built-in table of contents in Github that lets you search through the contents, as well:

image

It looks like this is what you're looking for? In general I'd prefer to avoid hand-maintaining a list of headers that may change in the README if possible.

JaimeTorrealba commented 1 month ago

Indeed thanks