README files and descriptions

Author: radkovo

fitlayout-cli/Dockerfile

@@ -1,4 +1,5 @@
 FROM fitlayout/fitlayout-core
+LABEL maintainer="Radek Burget, burgetr@fit.vutbr.cz" description="FitLayout Command-line interface (CLI) image."
 
 # A folder for sharing the output
 ENV OUT /out

fitlayout-cli/README.md

@@ -9,7 +9,7 @@ This image provides a docker image with the [command-line interface](https://git
 
 Docker must be installed on your system to use the docker images.
 
-## Configuration and usage
+## Configuration
 
 Download the [fitlayout.sh](https://github.com/FitLayout/docker-images/blob/main/fitlayout-cli/fitlayout.sh) script from GitHub:
 
@@ -18,12 +18,28 @@ wget https://raw.githubusercontent.com/FitLayout/docker-images/main/fitlayout-cl
 chmod 755 fitlayout.sh
 ```
 
-Then, run fitlayout CLI using
+Optionally, you may want to edit the `fitlayout.sh` file for changing the location of the following folders:
+
+- `STORAGE_PATH` - the folder where the local RDF repository lives. If an empty folder is provided, a new repository will be initialized. It is set to `/opt/fitlayout/storage` by default.
+- `OUTPUT_FOLDER` - the folder used for storing the output produced by the `EXPORT` command. Within the container, this folder is referenced as `/out` (i.e. use for example `EXPORT -f xml -o /out/file.xml` for exporting a XML file (see a complete example below).
+
+## Usage
+
+Run fitlayout CLI using
 
 ```bash
 ./fitlayout.sh [<commands>]
 ```
 
-For the first time, the related docker images will be downloaded which may take some time.
+For example:
+
+```bash
+./fitlayout.sh \
+    RENDER -b puppeteer http://cssbox.sf.net \
+    SEGMENT -m vips -O pDoC=9 \
+    EXPORT -f xml -o /out/file.xml
+```
+
+On first run, the related docker images will be pulled which may take some time.
 
-See the [command-line interface documentation](https://github.com/FitLayout/FitLayout/wiki/Command-line-Interface) for the commands reference and examples.
+See the [command-line interface documentation](https://github.com/FitLayout/FitLayout/wiki/Command-line-Interface) for a complete command reference and examples.

fitlayout-core/README.md

@@ -0,0 +1,12 @@
+FitLayout/2 - Base Docker Image
+===============================
+
+(c) 2015-2021 Radek Burget (burgetr@fit.vutbr.cz)
+
+This is a base image used by the remaining images. It contains the following components:
+
+- Compiled [FitLayout framework](https://github.com/FitLayout/FitLayout) components
+- Configured [fitlayout-puppeteer](https://github.com/FitLayout/fitlayout-puppeteer) rendering backend
+- The required runtime environment including Java and node.js
+
+See the [fitlayout-cli](https://github.com/FitLayout/docker-images/tree/main/fitlayout-cli) image for getting a runnable image with a command-line interface.

fitlayout-server/Dockerfile

@@ -1,4 +1,5 @@
 FROM fitlayout/fitlayout-core
+LABEL maintainer="Radek Burget, burgetr@fit.vutbr.cz" description="FitLayout server image with a REST API."
 
 ENV PORT 8400
 

fitlayout-server/README.md

@@ -0,0 +1,6 @@
+FitLayout/2 - Server Docker Image
+=================================
+
+(c) 2015-2021 Radek Burget (burgetr@fit.vutbr.cz)
+
+This image contains an implemenation of a server application with a REST API providing access to the FitLayout functions.