diff --git a/README.md b/README.md index efd4047..aeedf16 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,65 @@ # svg2ild -Converts a series of .svg files to .ild animation for laser shows -ILDA - image data transfer format for laser shows +## Table of contents + + + + +- [Table of contents](#table-of-contents) +- [About](#about) +- [Installation](#installation) +- [How does it work](#how-does-it-work) +- [How to](#how-to) + - [How to detect an internal format of .ild file](#how-to-detect-an-internal-format-of-ild-file) +- [Links](#links) +- [License](#license) + + + +## About + +Converts a series of `.svg` files to `.ild` animation for laser shows. +Supports both static and animated images. + +ILDA - image data transfer format for laser shows. + +Description of the format: + +* Official: (80 KiB, revision 011, ). +* Made by author of the `LaserBoy`: . + +## Installation + +## How does it work + +Optimizations: + +* Order of objects in the input SVG file is not important — `svg2ild` finds nearest edges after each object. +* Palette: ? + +## How to + +### How to detect an internal format of .ild file + +You can use [file](https://en.wikipedia.org/wiki/File_%28Unix%29) tool from package `file` ([sources](https://www.darwinsys.com/file/)): + +```console + % file ./*.ild +./hs.ild: ILDA Image Data Transfer Format 3D Coordinates with Indexed Color, company MIKLO, number of records 88, palette number 0, number of frames 1 +./opos.ild: ILDA Image Data Transfer Format 3D Coordinates with Indexed Color, company MIKLO, number of records 2137, palette number 0, number of frames 1 +./rgb.ild: ILDA Image Data Transfer Format 3D Coordinates with Indexed Color, company MIKLO, number of records 18, palette number 0, number of frames 1 +./text-paths.ild: ILDA Image Data Transfer Format 3D Coordinates with Indexed Color, company MIKLO, number of records 102, palette number 0, number of frames 1 +``` + +## Links + +* Homepage: . +* Documentation: . +* Mirror: . + +## License + +AGPL v3.0