README
¶
Installation
To install a local development version, run the following command:
go install ./cmd/forester/
To install the latest version from the git repository, run:
go install git.sr.ht/~jonsterling/forester/cmd/forester@latest
Then the forester command should be available if ~/go is in your PATH.
Patches
Please send patches to ~jonsterling/forester-devel@lists.sr.ht.
Example
To see forester in action, let's run it against the examples, which contains a fenced LaTeX code block as well as some links and embeds:
go run cmd/forester/main.go -force -input-dir examples -out-dir assets -graph-dir data -latex
After running this command, data/forest.yml will contain a dependency graph and some svg files will be deposited in the assets directory. The name of the svg file is the md5 hash of the LaTeX code that it was generated from. Finally, LaTeX files will be deposited in the latex directory, which can be included from the file latex/main.tex which we supply as an example.
Directories