search

andreasala98 / NM4PIG

Numerical Methods for Photorealistic Image Generation
MIT License
2 stars 1 forks source link

Camera and Ray features #2

Closed TommasoArmadillo closed 3 years ago

TommasoArmadillo commented 3 years ago

This is a PR for implementing class and methods for Camera, Ray, ImageTracer objects.

TommasoArmadillo commented 3 years ago

The C# documentation suggests using this tool docFx to automatically read the XML documentation and generates API reference website. I read also that it is possible to use GitHub Actions for automatically create a website whenever there is a push, and deploy it with GitHub Pages. In the weekend I'll finish the doc and try to do this. Here are some useful links, just for reference

Official documentation docFx Technical tutorial GitHub action Complete tutorial

Before merging I would wait to see where this ends up

andreasala98 commented 3 years ago

The C# documentation suggests using this tool docFx to automatically read the XML documentation and generates API reference website. I read also that it is possible to use GitHub Actions for automatically create a website whenever there is a push, and deploy it with GitHub Pages.

Great suggestion, @TommasoArmadillo! I'll read the C# documentation as well and maybe give it a try over the weekend.

Before merging I would wait to see where this ends up

Totally agree with you on this!

andreasala98 commented 3 years ago

Very good job @TommasoArmadillo and @PietroKlausner. We did everything that we were supposed to do within the cameras branch. We also deployed to GitHub Pages the creation of a documentation webpage. I now proceed with the merge.