From 5703432526ae2eef3834f1d62fc3191b09a1c3ae Mon Sep 17 00:00:00 2001 From: Michael Specht Date: Wed, 14 Feb 2018 23:36:04 +0100 Subject: [PATCH] documentation --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 5999371..5ebc34f 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,10 @@ $ ./champ.rb --max-frames 100 plot3d.yaml This will run the emulator and write the HTML report to `report.html`. If you do not specify the maximum number of frames, you can still cancel the emulator by pressing Ctrl+C at any time. If you need fast results and don't need the animated GIF of all frames, specify the `--no-animation` flag, which will still give you all the information but without the animation. +## Example report + ![Champ Screenshot](doc/screenshot.png?raw=true "Fig. 1 Champ Screenshot") +## Did you know? + By the way, there's a full-fledged, standalone, no-dependencies GIF encoder in `pgif.c` that writes animated GIFs and uses some optimizations to further minimize space.