Add some documentation

Open pomeroyb opened this issue 5 years ago • 1 comments

These docs aren't complete, but I figured it'd be good to start this pull request now so duplicate readmes aren't written.

Also you keep adding functions so the docstrings are also a bit behind!

The /docs/images folder I was planning to populate with images from your meshview program, but it may be better to now generate the images with the render.go util for consistency.

Feb 13 '21 04:02 pomeroyb

Thanks for the help! I've got the README and sample images under control, but I could pull in your docstrings - can you update your PR to only include those?

Feb 13 '21 19:02 fogleman