# Dickinson

Dickinson is a text-generation language.

## Installation

### Binary Releases

Binaries for some platforms are available on the [releases
page](https://github.com/vmchale/dickinson/releases).

Unpack the distribution, then:

```
make install
```

### Script

There is an install script which will try to download the right release for your
computer:

```bash

curl -sSl https://raw.githubusercontent.com/vmchale/dickinson/master/bash/install.sh | sh -s
```

### Source

To install, get [cabal-install](https://www.haskell.org/cabal/) and
[GHC](https://www.haskell.org/ghc/download.html). Then:

```
cabal install language-dickinson
```

Manpages are installed at

```
emd man
```

So `man $(emd man)` will pull them up in bash, for instance.

### Editor Integration

Editor integration is available for vim.

Using [vim-plug](https://github.com/junegunn/vim-plug):

```vimscript
Plug 'vmchale/dickinson' , { 'rtp' : 'vim' }
```

## Documentation

A user guide is available in
[markdown](https://github.com/vmchale/dickinson/blob/master/doc/user-guide.md)
and as
a [pdf](https://github.com/vmchale/dickinson/blob/master/doc/user-guide.pdf).

See `man/emd.1` for man pages.

### Examples

A riff on the Unix fortune program is available
[here](https://github.com/vmchale/dickinson/blob/master/examples/fortune.dck).
Try

```
emd run examples/fortune.dck
```

Other examples are in the
[`examples`](https://github.com/vmchale/dickinson/tree/master/examples)
directory.