Add README explaining that it's an unofficial repository

The packages in this repository don't respect the Parabola policies
because:
- FSDG compliant distributions don't all have the same policies[1],
  and here we will packaging rootfs from other FSDG distributions.
- Packaging rootfs from any distribution also require to break some
  policies: even if we package a Parabola rootfs in this way, we will
  need to enable networking during builds. We will also most likely
  need to have root permissions during the build as well.

Though since it's hosted in the Parabola infrastructure it still needs
to be FSDG compliant, so only FSDG compliant distributions go there.

The list of FSDG compliant distributions is available on the GNU
website[2][3].

References:
-----------
[1]https://libreplanet.org/wiki/Group:Software/FSDG_distributions
[2]https://www.gnu.org/distros/free-distros.html
[3]https://www.gnu.org/distros/free-non-gnu-distros.html

Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>

1 files changed, 84 insertions, 0 deletions

diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..f2745d6
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,84 @@
++--------------+
+| Introduction |
++--------------+
+This repository is an attempt to produce various FSDG compliant docker
+images and see if it could integrate well into existing use
+cases/workflows:
+
+- Since PureOS and Trisquel are respectively based on Debian stable
+  and LTS versions of Ubuntu, and that Debian and Ubuntu are commonly
+  used in Dockerfiles, it might be possible to use existing
+  Dockerfiles with PureOS and Trisquel images instead.
+
+- Docker is available in most GNU/Linux distributions, and also works
+  on most FSDG compliant distributions[1].
+
+[1]https://libreplanet.org/wiki/Group:Software/research/DistroExecutionEnvironments
+
+The docker images are produced as Parabola packages to give somewhat
+equivalent guarantees than with Parabola packages.
+
+This means that once we have packages, they will be signed, mirrored,
+and that you will be able use them offline with your own mirror,
+etc. Though there will be some differences mentioned in the "Policies"
+section below.
+
++--------+
+| Status |
++--------+
+Right now Parabola doesn't ship any of these packages, but if you have
+configured sudo to run without password, you can run makepkg and get
+packages of a docker images that are usable with docker import.
+
+One of the big limitation is that this image is not yet
+redistributalbe as-is as we still need to find a way to get the source
+code corresponding to the images.
+
++----------+
+| Policies |
++----------+
+To make these packages, we had to bend some rules that are in place in
+Parabola. So this repository should be considered unofficial because
+of that.
+
+Parabola also hosts other unofficial repositories like contributor
+repositories and also hosts repositories with extra requirements (like
+the nonprism repository).
+
+Here are some of the rules that had to be bent or broken:
+- The packages are not built from source in a PKGBUILD. Instead it's
+  up to the upstream distributions to choose to build packages from
+  source or not. In any case FSDG compliant distributions are expected
+  to be able to provide the source code corresponding to the package
+  binary, else the packages wound't be free software. Though most FSDG
+  compliant distributions either build software from source or reuse
+  packages built from source because it makes license compliance
+  easier.
+
+- Parabola is more strict than other FSDG distriubtion as it has free
+  culture requirements and generally always require free software
+  licenses. So license like CC-BY-ND are generally not allowed in
+  Parabola for non-functional game data for instance. Though there
+  seems to be an exception for the license of the licenses.
+
+  So in practice users installing packages from other FSDG compliant
+  distributions might end up with games that have artwork under
+  CC-BY-ND licenses.
+
+- The PKGBUILDs require network access as they use utilities like
+  debootstrap to download a given distribution. Though the image are
+  reproducible and we do check the checksums of the resulting image to
+  make sure they cannot be arbitrary modified by the network or the
+  mirrors being used.
+
+- In debian based distributions like Trisquel and Pureos,
+  debuerreotype is being used to produce reproducible images. The
+  issue is that debuerreotype requires root, and no one managed yet to
+  make it work with fakeroot or similar utilities or to fix
+  debuerreotype. So we used sudo in the PKGBUILDs. As sudo without
+  password is usually used with libremakepkg, this shound't be a big
+  issue.
+
+- The licensing information is not precise, as an image like that is
+  constituted by a lot of different licenses, but the images are FSDG
+  compliant.