Skip to content

update readme - #80

Merged
mkofler96 merged 1 commit into
mainfrom
update-readme
Oct 8, 2026
Merged

mkofler96 merged 1 commit into
mainfrom
update-readme

Conversation

@mkofler96

Copy link
Copy Markdown
Owner

This pull request updates the README.md to add new documentation and improve citation handling. The most significant change is the addition of a detailed example for reconstructing shapes from STL files using the LocalShapesReconstructor class, making it easier for users to get started with mesh fitting. Additionally, the citations section is enhanced with collapsible BibTeX entries for relevant publications, and redundant citation instructions are removed for clarity.

Documentation improvements:

  • Added a new section describing how to use the LocalShapesReconstructor class to fit a field of local shapes to an STL mesh, including a code example, explanation of parameters, and sample output. This helps users quickly understand and apply the mesh reconstruction workflow.
  • Clarified the description of the "Rounded Cone" primitive in the geometric primitives table.

Citation and references section updates:

  • Added collapsible BibTeX entries for two key publications that use DeepSDFStruct, making it easier for users to cite relevant work.
  • Removed redundant explicit BibTeX citation instructions for the lattice structure functionality, as this information is now included in the collapsible entries above.

Copilot AI balanced review requested due to automatic review settings October 8, 2026 12:44

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@mkofler96
mkofler96 merged commit eebd1ed into main Oct 8, 2026
9 of 10 checks passed
@mkofler96
mkofler96 deleted the update-readme branch October 8, 2026 12:44
@deepsource-io

deepsource-io Bot commented Oct 8, 2026

Copy link
Copy Markdown

DeepSource Code Review

We reviewed changes in b97b1c4...b22b2fc on this pull request. Below is the summary for the review, and you can see the individual issues we found as inline review comments.

See full review on DeepSource ↗

PR Report Card

Overall Grade   Security  

Reliability  

Complexity  

Hygiene  

Code Review Summary

Analyzer Status Updated (UTC) Details
Python Oct 8, 2026 12:45p.m. Review ↗

Important

AI Review is run only on demand for your team. We're only showing results of static analysis review right now. To trigger AI Review, comment @deepsourcebot review on this thread.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants