summaryrefslogtreecommitdiff
path: root/README
blob: d28d8bcb3ccffeb7be7baecee38c45e338f5267f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
overview
--------

This is the Adélie Wallpapers repository. It contains
the original source images, metadata, and brand assets
to generate wallpapers for the Adélie Linux distribution.


structure
---------

The only choices a contributor has are '<slug>' and
'<ext>'. All other variables are in 'MANIFEST'.

    /                      <-- this repository
        /<slug>/           <-- image name slug
             /image.<ext>  <-- image    file
             /MANIFEST     <-- metadata file
        /prepare           <-- generator script
        /prepare-docker    <-- for production only*


building
--------

(1) ensure that you have cloned the full repository

(2) ensure that you are checked out at a tag that has
    been pushed to origin

(3) run the 'prepare'* script with no arguments, or run
    the 'prepare-docker' script to do this in a container
    with a known version of imagemagick or graphicsmagick
    if you are preparing for a release

(4) upload the resulting tarball, in 'output/', to the
    distfiles mirror, directly under 'source/'


contributing
------------

You must agree to license your contributions in a manner
consistent with the license of this repository.

Follow the structure specified above. Examples abound.


license
-------

All images in this repository are distributed under the
Creative Commons Attribution Share-Alike (CC BY-SA) 4.0
license, a copy of which may be found here:

    https://creativecommons.org/licenses/by-sa/4.0/

This covers the output tarball and its contents.

The 'prepare' script is distributed under the Apache 2.0
license, and is not included in the output tarball.

The GitLab project repository icon is from here:

    https://www.iconfinder.com/icons/2499015/background_image_landscape_laptop_wallpaper_icon
    https://creativestall.com/

We consider it Fair Use for illustrative purposes.