search

ricosjp / truck

Truck is a Rust CAD Kernel.
Apache License 2.0
992 stars 53 forks source link

`README.md` in each crate #45

Open ytanimura opened 1 year ago

ytanimura commented 1 year ago

Consider for README.md in each crate cf. README.md by virtualritz

MattFerraro commented 1 year ago

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 commented 1 year ago

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?