hashirama/reanimate
Watch
1
0
Fork
You've already forked reanimate
 0
mirror of https://github.com/reanimate/reanimate.git synced 2026-09-14 09:32:22 +00:00
Code Issues Projects Releases Wiki Activity

Add how-to-get-started section to the README.

Browse source
This commit is contained in:
David 2019-03-09 15:04:52 +01:00
commit f563c0d917
1 changed files with 16 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -1,13 +1,28 @@
# reanimate
Reanimate is a reactive framework for creating non-interactive animations from SVG images.
This package consists of a set of arrow combinators, a renderer (using ffmpeg), and a web-based
This package consists of a set of combinators, a renderer (using ffmpeg), and a web-based
previewer. Inline latex code is supported when 'latex' and 'dvisvgm' are installed.
Nothing about the API is stable at this point.
Live coding playground: https://lemmih.github.io/reanimate/
# Getting started
Reanimate ships with a web-based viewer and automatic code reloading. To get a small demo
up and running, clone the repository, run one of the examples (this will install the library),
and wait for a browser window to open:
```console
# git clone https://github.com/Lemmih/reanimate.git
# cd reanimate/examples/
# ./latex_color.hs
```
This should render the `latex_color` example in a new browser window. If you then change the
animation source code, the browser window will automatically reload and show the updated animation.
# TODO
* ~~website for live coding~~