Skip to content

Commit

Permalink
Added further description to demos
Browse files Browse the repository at this point in the history
  • Loading branch information
cjrolo committed Nov 20, 2024
1 parent aa95edd commit 20256a8
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion atsc/demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ The output HTML files (for error levels 1% and 3%) can then be used to visualize

Three demo output files are provided so that comparison can be made without needing to run the compressor even once if a quick evaluation is needed. Or if you are curious what is this all about!

## What is in each file?

Each HTML file renders the output of all compressor options (`FFT`, `IDW` and `Polynomial`) with an error indicated in the file name (1% or 3%). Also, the input data is rendered.

On top, it is possible to click in each option to hide display each option and have a visual comparison between options.

## Contents

This folder contains scripts to generate the demo `html` files.
Expand All @@ -34,7 +40,7 @@ The files are the following:

## Create your own demo files

1. change into the current directory:
1. Change into the current directory:

```bash
cd atsc/demo
Expand Down

0 comments on commit 20256a8

Please sign in to comment.