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
This commit is contained in:
David Himmelstrup 2019-09-19 16:52:34 +08:00 committed by GitHub
commit 23146429a5
9 changed files with 268 additions and 3 deletions

24
docs/index.md Normal file
View file

@ -0,0 +1,24 @@
# 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
```