reanimate/docs/index.md
David Himmelstrup 23146429a5 Documentation. (#12)
* First docs.

* Docs requirements.

* Add auto-generated gallery and fix two bugs in the driver.

* Gallery: link directly to github.

* Tag examples as Haskell code.

* Update starting guide and redirect gallery links to master branch.

* Include link to readthedocs.


Former-commit-id: 90e846e5001deadd6c921f611c69b3a4210db30d
2019-09-19 16:52:34 +08:00

24 lines
383 B
Markdown

# Getting started
## Viewing a basic animation
```console
$ git clone https://github.com/Lemmih/reanimate.git
$ cd reanimate/
$ stack build
$ stack ./examples/raster.hs
```
## Checking dependencies
Reanimate includes a run-time for optional dependencies.
```console
$ stack ./examples/raster.hs check
```
## Rendering movies
```console
$ stack ./examples/raster.hs render
```