Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README.md in each crate #45

Open
ytanimura opened this issue Mar 3, 2023 · 2 comments
Open

README.md in each crate #45

ytanimura opened this issue Mar 3, 2023 · 2 comments

Comments

@ytanimura
Copy link
Contributor

Consider for README.md in each crate cf. README.md by virtualritz
@ytanimura ytanimura mentioned this issue Mar 3, 2023
Merged
@MattFerraro
Copy link

I would love to see a readme that describes in a few sentences the primary data types and when you're supposed to use which ones. There seems to be a few like Vector3, Point3, Vertex, which all seem similar. There's also things like Edge and Wire and Line, and I'm not sure when I should use one over another.

@ytanimura
Copy link
Contributor Author

Thank you for your comment.

Would it be sufficient to write something similar to the beginning of the truck-topology document in each crate README?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@MattFerraro @ytanimura