tikz-gallery-generator

Custum build of stapix for tikz.pablopie.xyz

Diffstat

1 file changed, 62 insertions, 2 deletions

diff --git a/README.md b/README.md
@@ -1,3 +1,63 @@
-# StaPix
+# stapix
+
+Yet another static page generator for photo galleries
+
+## 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
+
+### 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:
+
+```console
+$ stapix config.yml
+```
+
+The configuration file `config.yml` should consist of a list of file-paths
+pointing to the images the user wants in the gallery and text alternatives for
+each image, such as in the following example:
+
+```yaml
+- path: ./path/to/first.jpg
+  alt: "Text alternative for the first photo"
+- path: ./path/to/second.png
+  alt: "Text alternative for the second photo"
+...
+```
+
+## Installation
+
+stapix can be installed via Cargo by cloning this directory, as in:
+
+```console
+$ git clone git://git.pablopie.xyz/stapix
+$ cargo install --path ./stapix
+```
+
+## License
+
+This program is free software: you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation, either version 3 of the License, or (at your option) any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with
+this program. If not, see <https://www.gnu.org/licenses/>.
 
-Yet another gallery generator