Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Erin van der Veen committed Jun 10, 2024
1 parent c7859df commit 1a7577e
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ Output from Genealogos can be used by various other tools to perform further ana
Note Nix is mainly just suitable for Software, and so the BOM output by Genealogos is nearly always an SBOM.
However, for consistency, we will refer to the output as a BOM.

The project is still very early stages, so the output may as of yet be of little use.
Genealogos may already be used to generate SBOMs but it is important to realize there exist some known issues.
See the section at the end of this readme for a list of known issues and other limitations.

## Installing Genealogos-cli
Right now, Genealogos is only distributed via our Nix Flake.
Expand Down Expand Up @@ -203,6 +204,10 @@ In order to make working with these fixtures a little nicer, the `nix develop .#
And `update-fixture-files`, which should be ran when an update to `genealogos` changes its output.
Note that this second script requires that `genealogos-cli` is buildable.

## Known issues and limitations
Currently, Genealogos (through nixtract) tries to find all attributes that are input derivation to whatever package is being analyzed.
This means some inputs can be missed, in particular those that are part of string contexts.

## License
Distributed under the MIT License. See `LICENSE` for more information.

Expand Down

0 comments on commit 1a7577e

Please sign in to comment.