mirror of
https://github.com/FliegendeWurst/hypergraph-drawing.git
synced 2024-09-07 21:21:48 +00:00
Update README.md
This commit is contained in:
parent
72dec5ebc9
commit
7d6e62185d
15
README.md
15
README.md
@ -2,7 +2,7 @@
|
||||
|
||||
## Usage
|
||||
|
||||
Requires Python 3, [pydot](https://pypi.org/project/pydot/) (tested with 1.4.2), [Asymptote](https://asymptote.sourceforge.io/) (tested with 2.67) and LaTeX (tested with TeX Live 2021).
|
||||
Requires Python 3 (tested with 3.9.13), [pydot](https://pypi.org/project/pydot/) (tested with 1.4.2), [Asymptote](https://asymptote.sourceforge.io/) (tested with 2.67) and LaTeX (tested with TeX Live 2021).
|
||||
|
||||
To render a hypergraph specified in `graph.dot`, execute the following:
|
||||
```bash
|
||||
@ -11,6 +11,18 @@ asy -f png graph.asy
|
||||
```
|
||||
You may adjust the font size, width/height of the output and more by editing the values at the beginning of the script.
|
||||
|
||||
To embed the graph in a LaTeX document, set `output_latex` to true.
|
||||
```latex
|
||||
\usepackage[inline]{asymptote}
|
||||
% ...
|
||||
\begin{figure}
|
||||
\centering
|
||||
\input{output.asy}
|
||||
\caption{...}
|
||||
\label{fig:...}
|
||||
\end{figure}
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
| Original graph | Asymptote rendering |
|
||||
@ -41,3 +53,4 @@ The generated code is based on https://tex.stackexchange.com/a/108099/185782 by
|
||||
## License
|
||||
|
||||
[CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)
|
||||
(open an issue if you'd prefer a different license)
|
||||
|
Loading…
Reference in New Issue
Block a user