summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README64
1 files changed, 64 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..669925c
--- /dev/null
+++ b/README
@@ -0,0 +1,64 @@
+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
+
+
+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
+
+(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.