From f536c144aadd0068f60c56afdc915a830c7e1ce6 Mon Sep 17 00:00:00 2001
From: Jan Staněk <jstanek@redhat.com>
Date: May 28 2019 14:11:33 +0000
Subject: Fill README with basic repository information


- List and link to the syntax explanation
- Describe buildlogs synchronization assumptions
- Describe mirrors synchronization assumptions

---

diff --git a/README b/README
deleted file mode 100644
index 2dead3d..0000000
--- a/README
+++ /dev/null
@@ -1 +0,0 @@
-Here is the README file
diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000..5c34728
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,37 @@
+# Control files for CBS ↔ repositories synchronization
+
+This repository contains control files for the synchronization process
+between CBS tags and RPM repositories.
+
+The general syntax of these files follows this convention ([wiki][sync-legend-wiki]):
+
+    <tag>|<destination path>|<dir to run createrepo in>|<destination on mirror.centos.org>
+
+Example:
+
+    cloud7-openstack-rocky-release/|7/cloud/x86_64/openstack-rocky/|7/cloud/x86_64/openstack-rocky/|7/cloud/x86_64/openstack-rocky/
+    cloud7-openstack-rocky-release/|7/cloud/ppc64le/openstack-rocky/|7/cloud/ppc64le/openstack-rocky/|7/cloud/ppc64le/openstack-rocky/
+
+[sync-legend-wiki]: https://wiki.centos.org/SIGGuide/Content/Mirror "Steps to request space on the mirror network"
+
+## Buildlogs synchronization
+
+The file in control of buildlogs synchronization is `buildlogs_list`.
+As stated at the top of that file, it is universal for all architectures
+– the synchronization script will automatically substitute `aarch64`/`ppc64le`
+for `x86_64` for any tags that have content on the respective architecture.
+
+## Mirrors synchronization
+
+The synchronization to mirrors is controlled by architecture-specific `sign_list` file:
+
+<table>
+  <thead>
+    <tr><th>File name</th><th>Architecture</th></tr>
+  </thead>
+  <tbody>
+    <tr><td><code>sign_list</code></td><td>x86_64</td></tr>
+    <tr><td><code>sign_list.aarch64</code></td><td>aarch64</td></tr>
+    <tr><td><code>sign_list.ppc64le</code></td><td>ppc64le</td></tr>
+  </tbody>
+</table>