diff --git a/README.md b/README.md
@@ -3,30 +3,12 @@
Custum build of [`stapix`](https://git.pablopie.xyz/stapix) for
<https://tikz.pablopie.xyz>.
-## Philosophy
-
-stapix is [suckless software](https://suckless.org/). The application was
-inspired by [stagit](https://codemadness.org/stagit.html) and other similar
-static site generators. It aims to provide a minimalist user interface and
-implement the following simple feature set:
-
-* Accessible and optimized HTML output implementing current best practices
-* Simple static webpages with no need for JavaScrip
-* Automatically generate WebP thumbnails in parallel
-
-For a live example please see <https://photos.pablopie.xyz>!
-
-### Customizing the HTML Output
-
-The user is expected to modify the source code to customize the HTML output.
-_No templating system is provided_.
-
## Usage
-To use stapix run:
+Run:
```console
-$ stapix config.yml
+$ tikz_gallery_generator config.yml
```
The configuration file `config.yml` should consist of a list of struct entries
@@ -51,8 +33,8 @@ describing the contents of each picture, such as in the following example:
Each entry in the list should contain the following fields:
* **`path`:** The path to the file in question
-* **`alt`:** Text altenative for the picture
-* **`caption` (optional):** A description of the picture
+* **`alt`:** Text altenative for the figure
+* **`caption` (optional):** A description of the figure
* **`author`:** The name of the author of the picture
* **`author-url` (optional):** A URL to a webpage by/on the picture's author
* **`license`:** The license type of the picture. Should be one of
@@ -65,6 +47,8 @@ Each entry in the list should contain the following fields:
`CC-BY-ND-1`, `CC-BY-ND-2`, `CC-BY-ND-2.1`, `CC-BY-ND-2.5`, `CC-BY-ND-3`,
`CC-BY-ND-4`, `CC-BY-NC-ND-1`, `CC-BY-NC-ND-2`, `CC-BY-NC-ND-2.1`,
`CC-BY-NC-ND-2.5`, `CC-BY-NC-ND-3` or `CC-BY-NC-ND-4`
+* **`source` (optional):** A URL poiting to the original source of the figure,
+ if available
For best accessibility, the `alt` field should contain a concise visual
description of the picture in question (including subjects, colors and scenery)
@@ -76,13 +60,18 @@ should not be the same!** See
## Installation
-stapix can be installed via Cargo by cloning this directory, as in:
+`tikz_gallery_generator` can be installed via Cargo by cloning this directory,
+as in:
```console
-$ git clone git://git.pablopie.xyz/stapix
-$ cargo install --path ./stapix
+$ git clone git://git.pablopie.xyz/tikz-gallery-generator
+$ cargo install --path ./tikz-gallery-generator
```
+## External Dependencies
+
+* [tikztosvg](https://www.ctan.org/pkg/tikztosvg)
+
## License
This program is free software: you can redistribute it and/or modify it under