From ae313f1f44f1ceb50412205dfbd9fcdf7422a0fd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Manoel=20R=C3=B6mmer?= <m.roemmer@fz-juelich.de>
Date: Fri, 1 Dec 2023 09:14:46 +0100
Subject: [PATCH] Update README.md

---
 README.md | 27 +++++++++++++++------------
 1 file changed, 15 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 8b54f8407..5c73b22f7 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,19 @@
-# JSC's EasyBuild private repo
-This is the repo to store all the EasyBuild configuration files, including easyconfigs.
+# The DEEP-SEA Software Release EasyBuild Repository
 
-Each stage is in a separate branch, containing all the relevant files for that stage
+This repository is the public software release of the DEEP-SEA project. It
+contains the EasyBuild configuration for the software developed during the
+DEEP-SEA project deployed with EasyBuild to the DEEP system.
 
+## Information for Project Partners
 
-This repository uses [autopep8](https://github.com/hhatto/autopep8) and [pre-commit](https://pre-commit.com). For that, you need to run this on your machine:
-
-```sh
-pip3 install --user autopep8
-pip3 install --user pre-commit
-pre-commit install
-```
-
-After those steps, `pre-commit` will call `autopep8` on each commit, and make small changes pass the pep8 test without needing to do a manual `eb --check-style` and checking each little mistake.
+Project partners should continue providing their EasyBuild EasyConfigs to the
+internal [EasyBuild repository for the DEEP-SEA project](https://gitlab.jsc.fz-juelich.de/deep-sea/wp3/software/easybuild-repository-deep-sea/)
+on the `2023` branch. This repository will be synced with the internal one by
+the time of the public software release.
 
+Please note that the public software release will be completely based on the
+DEEP software stage `2023`. Project partners are advised to contribute
+EasyConfigs that use appropriate toolchains and dependencies from this software
+stage. Furthermore, EasyConfigs should only reference publicly available
+sources (insofar as this is possible) by the time of the public software
+release.
-- 
GitLab