jplatte / cargo-depgraph

Creates graphviz dependency graphs for Rust projects that use Cargo
GNU General Public License v3.0
151 stars 8 forks source link

Readme guide missing a step #13

Closed AJAnderson closed 1 year ago

AJAnderson commented 1 year ago

Hello,

The installation and first use guide is a bit hard to understand, I'm currently stuck as I don't know what "dot" is that the output of depgraph is being piped to, it's not a super easy thing to google either. It's not a recognized internal command on windows, so perhaps a brief explanation on what this is would help new users like myself?

AJAnderson commented 1 year ago

Figured out it's the shorthand for a tool graphviz offers. Minor papercut for new users not starting with graphviz installed or otherwise knowing all that much about it.

jplatte commented 1 year ago

Added a note in ba86465c46707a3c2d4f5912fc0eba63b20a2c61. Let me know if you think it still needs further improvements.

AJAnderson commented 1 year ago

Yeah that looks great, thank you!