From 5da4f726809afe259547826e0e3c09598de7eabe Mon Sep 17 00:00:00 2001
From: Tim-Oliver Buchholz <tim-oliver.buchholz@fmi.ch>
Date: Thu, 6 Jun 2024 12:19:10 +0200
Subject: [PATCH] Do not ignore the README.md files in raw_data,
 processed_data, and results.

---
 template/.gitignore               | 3 +++
 template/processed_data/README.md | 4 ++++
 template/raw_data/README.md       | 4 ++++
 template/results/README.md        | 4 ++++
 4 files changed, 15 insertions(+)
 create mode 100644 template/processed_data/README.md
 create mode 100644 template/raw_data/README.md
 create mode 100644 template/results/README.md

diff --git a/template/.gitignore b/template/.gitignore
index 877272f..fc6c048 100644
--- a/template/.gitignore
+++ b/template/.gitignore
@@ -219,8 +219,11 @@ infrastructure/apps/**/
 
 # Data directories
 processed_data/**
+!processed_data/README.md
 raw_data/**
+!raw_data/README.md
 results/**
+!results/README.md
 
 # TMP
 infrastructure/.tmp_*/**
diff --git a/template/processed_data/README.md b/template/processed_data/README.md
new file mode 100644
index 0000000..6db6dfb
--- /dev/null
+++ b/template/processed_data/README.md
@@ -0,0 +1,4 @@
+# Processed Data
+This directory contains processed data, which is derived from your raw data.
+
+__Note:__ This directory is not tracked by git.
diff --git a/template/raw_data/README.md b/template/raw_data/README.md
new file mode 100644
index 0000000..b4e544a
--- /dev/null
+++ b/template/raw_data/README.md
@@ -0,0 +1,4 @@
+# Raw Data
+This directory contains your raw data.
+
+__Note:__ This directory is not tracked by git.
diff --git a/template/results/README.md b/template/results/README.md
new file mode 100644
index 0000000..4165508
--- /dev/null
+++ b/template/results/README.md
@@ -0,0 +1,4 @@
+# Results
+Finale results (e.g. plots and figures) are stored here.
+
+__Note:__ This directory is not tracked by git.