Skip to content

README.md

Latest commit

 

History

History
31 lines (21 loc) · 976 Bytes

README.md

File metadata and controls

31 lines (21 loc) · 976 Bytes

flow-basics

Dark-themed Graphviz flow diagrams with semantic classes. Write clean .dot files, get pretty SVG + PNG.

example

Using with AI agents

Tell your agent:

Generate a flow diagram for [your topic]. Read https://raw.githubusercontent.com/8ff/flow-basics/main/PROMPT.md for instructions.

The agent will write a .dot file, download render.py, and produce SVG + PNG automatically.

Manual usage

Requires graphviz and python3:

brew install graphviz       # macOS
apt install graphviz        # Linux
pkg install graphviz        # FreeBSD
pkg_add graphviz            # OpenBSD
./gen.sh                    # renders example.dot -> example.svg + example.png
./gen.sh myflow.dot         # renders myflow.dot  -> myflow.svg  + myflow.png
./gen.sh a.dot output       # renders a.dot       -> output.svg  + output.png

See PROMPT.md for the full .dot file format, node/edge classes, and conventions.