From f9fc0fbf2f0c3cdd0826f39475407c826b131a66 Mon Sep 17 00:00:00 2001
From: Marwan Abbas <67271180+marwaneltoukhy@users.noreply.github.com>
Date: Mon, 20 May 2024 17:30:58 +0530
Subject: [PATCH] Create README.md

---
 README.md | 7 +++++++
 1 file changed, 7 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..90a916f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,7 @@
+# Central CI
+
+This CI tests the user flow for several designs at once, it is made to have the latest most reliable set of tool versions to use in the user flow.
+
+Until now there are 2 designs being run: `caravel_user_project` and `openframe_timer_example`
+
+There are 2 CIs, one that runs nightly, and updates the tool versions in `tools.json` and the design versions in `.github/scripts/designs.json`, and a bot creates a PR if there are updates to these files. The other CI runs when the bot creates the PR, which runs the full user flow.