From f563c0d91796d1603f48ae0c49432551aba47d0f Mon Sep 17 00:00:00 2001 From: David Date: Sat, 9 Mar 2019 15:04:52 +0100 Subject: [PATCH] Add how-to-get-started section to the README. --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b85336f..194ff3d 100644 --- a/README.md +++ b/README.md @@ -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~~