File: README.markdown

package info (click to toggle)
haskell-diagrams 1.3.0.1-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 60 kB
  • sloc: haskell: 2; makefile: 1
file content (76 lines) | stat: -rw-r--r-- 2,998 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
[![Build Status](https://secure.travis-ci.org/diagrams/diagrams.png)](http://travis-ci.org/diagrams/diagrams)

[diagrams] is a full-featured framework and domain-specific langauge
(embedded in [Haskell]) for creating declarative vector graphics and
animations.

[diagrams]: http://projects.haskell.org/diagrams/
[haskell]: http://www.haskell.org/haskellwiki/Haskell

This package is just *a convenient wrapper* around the
[diagrams-core], [diagrams-lib], [diagrams-svg], and
[diagrams-contrib] packages, so they can be installed with a single
`cabal install diagrams` command.

[diagrams-core]: http://github.com/diagrams/diagrams-core
[diagrams-lib]: http://github.com/diagrams/diagrams-lib
[diagrams-svg]: http://github.com/diagrams/diagrams-svg
[diagrams-contrib]: http://github.com/diagrams/diagrams-contrib

The package also comes with flags to enable six different backends.
The [native SVG backend](http://github.com/diagrams/diagrams-svg) is
enabled by the `-fsvg` flag and is enabled by default.  If you don't
want it, you must explicitly disable it with `-f-svg`.

The
[native postscript backend](http://github.com/diagrams/diagrams-postscript)
is disabled by default but can be enabled by the `-fps` flag.

The [cairo backend](http://github.com/diagrams/diagrams-cairo) is
disabled by default but can be selected with the `-fcairo` flag.  In
addition, the [GTK backend](http://github.com/diagrams/diagrams-gtk)
is based on the cairo backend (but split into a separate package to
make installing the cairo backend easier).  It can be selected with
the `fgtk` flag.

The [native rasterific backend](http://github.com/diagrams/diagrams-rasterific) which is
disabled by default but can be selected with the `-frasterific` flag.

The [native canvas backend](http://github.com/diagrams/diagrams-canvas) which is
disabled by default but can be selected with the `-fcanvas` flag.

# Installation

```
cabal update && cabal install diagrams
```

or, to get the postscript backend in addition to the SVG backend:

```
cabal update && cabal install -fps diagrams
```

or, to get the cairo backend in addition to the SVG backend:

```
cabal update && cabal install gtk2hs-buildtools && cabal install -fcairo diagrams
```

# Reporting bugs

Issue trackers for all diagrams-related repositories are hosted under
the [diagrams organization on github](http://github.com/diagrams).  If
you know the specific package containing the bug, report it in the
issue tracker specific to that package (for example,
[diagrams-lib](http://github.com/diagrams/diagrams-lib/issues)).
Otherwise, just report the issue in the issue tracker for the
[general diagrams repository](http://github.com/diagrams/diagrams/issues).

# Further reading

For more information, including a gallery of examples, tutorial, and
user manual, see the
[diagrams website](http://projects.haskell.org/diagrams).  For help,
join the `#diagrams` IRC channel on Freenode or the
[mailing list](http://groups.google.com/group/diagrams-discuss).