quiver/README.md

# quiver
A graphical editor for commutative diagrams that exports to tikz-cd.

Try quiver out here: https://varkor.github.io/quiver

## Features
- An intuitive graphical interface for creating and modifying commutative diagrams.
- Support for objects, morphisms, natural transformations.
- A responsive, resizable grid.
- tikz-cd (LaTeX) export.
- Shareable links.
- Smart label alignment and edge offset.
- Curved arrows.
- Parallel (shifted) arrows.
- Arrow styles, including:
    - Dashed and dotted edges.
    - Maps to arrows.
    - Monomorphisms and epimorphisms.
    - Inclusions.
    - Pullbacks and pushouts.
    - Adjunctions.
    - Equality.
    - Harpoons.
    - Squiggly arrows.
    - Proarrows.
- Multiple selection.
- A history system with undo and redo.
- Panning.
- Support for custom macro definitions.

## Building
Make sure you have [installed yarn](https://yarnpkg.com/lang/en/docs/install/) and have a version of
make that supports `.ONESHELL` (e.g. GNU Make 3.82).

Clone the repository. Run:
```
make
```
Open `src/index.html` in your favourite web browser.

If that doesn't work, [open an issue](https://github.com/varkor/quiver/issues/new) detailing the
problem.

## Screenshots
The interface:

![image](https://user-images.githubusercontent.com/3943692/50499043-fd45be80-0a3d-11e9-8fdf-fabeb5476334.png)

Parallel arrows:

![image](https://user-images.githubusercontent.com/3943692/50520129-7aad1580-0ab6-11e9-93f8-3981af4f5e37.png)

Natural transformations:

![image](https://user-images.githubusercontent.com/3943692/50520158-a7f9c380-0ab6-11e9-932e-08d22bd8f125.png)

Adjunctions:

![image](https://user-images.githubusercontent.com/3943692/50531538-7c50fa80-0b03-11e9-9d94-f859395e340f.png)

## Thanks
- [@cartesiancat](https://github.com/cartesiancat) for discussions about rendering aesthetic arrows.
- [AndréC](https://tex.stackexchange.com/users/138900/andr%c3%a9c) for the custom TikZ `curve` style.