From faa385840142508cb722b6d735ea101ce353a496 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lucas=20Fr=C3=A9rot?= <lucas.frerot@sorbonne-universite.fr>
Date: Fri, 27 Dec 2024 08:18:42 +0100
Subject: [PATCH] added readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..de3ed9d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+> **READ FIRST**: [Good simulation practices wiki](https://git.dalembert.upmc.fr/lfrerot/good_simulation_practices/wiki)
+
+# Data and code tenets helper
+
+[Principles of code and data
+management](https://git.dalembert.upmc.fr/lfrerot/good_simulation_practices/wiki/Research-simulation),
+lists tenets that must be respected when working with simulation code and
+scientific data. This repository provides scripts to help automatically enfore
+these tenets (as much as possible).