Update README.md

This commit is contained in:
Dennis ten Hoove 2023-08-15 10:45:13 +02:00
parent b49e8418d5
commit ddebec399d

View file

@ -50,8 +50,15 @@ customlinux-gnome
customlinux-kde
```
The `database` file contains a `:` delimited list of all available images.
The `database` file contains a `:` delimited list of all available images. Each line contains the following information `image_name:compression_method:sha1sum`.
```text
customlinux_v1.0:zst:80ba4c7f3ff7a0ebce8e67d5b73f87c56af1b9f3
customlinux_v2.0:zst:d5f45b2dac77399b37231c6ec4e864d184d35cf1
customlinux_v1.0:zst:80ba4c7f3ff7a0ebce8e67d5b73f87c56af1b9f3
```
The image name is used to find the actual image, users can also manually refer to a version with `arkanium-deploy deploy customlinux customlinux_v1.0`
The compression method is flexible, any compression method tar can ifner is supported. Some examples being `xz`, `gz` and `zst`.
The sha1sum is used to ensure the file was downloaded properly.
Arkanium will assume the top most entry in the database is the latest one, when no image version is defined or `latest` is requested it will grab the top most entry.