README.md

@@ -1,4 +1,65 @@
 # svg2ild
 
-Converts a series of .svg files to .ild animation for laser shows
+## Table of contents
-ILDA - image data transfer format for laser shows
+
+<!--
+ Generate with: `md_toc --in-place --skip-lines 1 commonmarker README.md` (package `python3-md-toc` required).
+ Also, in GitLab, it can be replaced with just `[[_TOC_]]`.
+-->
+<!--TOC-->
+
+- [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)
+
+<!--TOC-->
+
+## 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: <https://ilda.com/resources/StandardsDocs/ILDA_IDTF14_rev011.pdf> (80 KiB, revision 011, <time>2014-11-16</time>).
+* Made by author of the `LaserBoy`: <https://laserboy.org/ilda_file_format.html>.
+
+## 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: <https://git.hswro.org/miklo/svg2ild>.
+* Documentation: <https://git.hswro.org/miklo/svg2ild/wiki>.
+* Mirror: <https://forge.citizen4.eu/miklo/svg2ild>.
+
+## License
+
+AGPL v3.0