This repository has been archived by the owner on Dec 13, 2022. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
1 addition
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,44 +1 @@ | ||
cargo-dot [![Build Status](https://travis-ci.org/maxsnew/cargo-dot.svg?branch=master)](https://travis-ci.org/maxsnew/cargo-dot) | ||
===================== | ||
|
||
A tool to graph transitive dependencies for Rust projects using Cargo | ||
|
||
Installation | ||
------------ | ||
In this project's directory, build the project and then add the binary to your `PATH`. | ||
```sh | ||
cargo build | ||
export PATH=$PATH:`pwd`/target/debug | ||
``` | ||
|
||
This will likely fail when used with the latest Rust nightly. If so, try | ||
```sh | ||
cargo update | ||
``` | ||
|
||
and then repeat the above steps. If it then succeeds, please submit a | ||
pull request with the new `Cargo.lock`. If it still fails, it is | ||
likely because Cargo is not updated to the latest nightly, which is | ||
common. | ||
|
||
Hopefully this will not be a problem once the beta starts and the | ||
nightlies are no longer the recommended installation method. See | ||
[here](http://blog.rust-lang.org/2015/02/13/Final-1.0-timeline.html) | ||
for details on the official timeline. | ||
|
||
Usage | ||
----- | ||
In a Rust project using Cargo, run the following commands (assuming | ||
cargo-dot is on your PATH) | ||
```sh | ||
cargo build # If you don't have a Cargo.lock file | ||
cargo dot | dot -Tsvg > Cargo.svg | ||
``` | ||
|
||
Examples | ||
-------- | ||
This project's dependencies | ||
![cargo-dot dependencies](etc/cargo-dot.png) | ||
|
||
Servo's dependencies | ||
![servo dependencies](etc/servo.png) | ||
This project is deprecated in favor of [cargo-graph](https://github.com/kbknapp/cargo-graph). |