Skip to content

Commit b70220d

Browse files
committed
Update readme to make things more clear
1 parent d967177 commit b70220d

1 file changed

Lines changed: 13 additions & 14 deletions

File tree

tools/rendergraph/README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
1-
# fossa-rendergraph
1+
# rendergraph
22

33
Utility to render the output of `fossa analyze -o` as a graph.
44

55
This program isn't _guaranteed_ to not be broken by new FOSSA CLI releases,
66
but we'll try to keep it from doing so especially since we try to keep output of FOSSA CLI stable.
77

8-
# Installation from source
9-
10-
0. Install `rust`: https://www.rust-lang.org/tools/install
11-
1. Clone this repo locally
12-
2. Run `cargo install --path rendergraph` from the parent directory.
13-
3. Use as `fossa analyze -o | rendergraph` (you can also `cat output.json | rendergraph`- any stdin works)
8+
`rendergraph` is unlikely to get additional features; we'll almost definitely roll this into other tooling
9+
such as FOSSA CLI or `ficus` itself if we choose to make changes to how this works.
1410

1511
# What to expect
1612

@@ -28,13 +24,6 @@ a
2824

2925
This tool outputs all dependencies found by FOSSA and doesn't currently account for FOSSA's "unused dependencies" graph pruning.
3026

31-
# Future work
32-
33-
A list of things I've thought of to add. Have an idea? Add it to this list via PR!
34-
35-
- [ ] Account for graph pruning (use source units to do this)
36-
- [ ] Support graphviz output
37-
3827
# Example output
3928

4029
Note: This output was truncated for readability.
@@ -226,3 +215,13 @@ github.com/fossas/fossa-cli@v1.1.10
226215
├─ github.com/Masterminds/semver@v1.5.0
227216
└─ github.com/BurntSushi/toml@v0.3.1
228217
```
218+
219+
# Installation from source
220+
221+
You should be able to manually download `rendergraph` from the FOSSA CLI github releases.
222+
However if you have to or want to build manually:
223+
224+
0. Install `rust`: https://www.rust-lang.org/tools/install
225+
1. Clone this repo locally
226+
2. Run `cargo install --path rendergraph` from the parent directory.
227+
3. Use as `fossa analyze -o | rendergraph` (you can also `cat output.json | rendergraph`- any stdin works)

0 commit comments

Comments
 (0)