From 0c4dd5a23925fd23b86172da9d0039fece29e60b Mon Sep 17 00:00:00 2001
From: Jevri <jevri.hanna@gmail.com>
Date: Tue, 17 Dec 2024 13:35:15 +0100
Subject: [PATCH] consolidated dr. watson README.md with "legacy" lab version

---
 README.md | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 61 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 70f5417..fef02cf 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,64 @@
-# template_project
+# **Project Template:** Put name of project here
+**Author:** *Your name*
+
+**Supervisor(s):** *Supervisor 1*, *Supervisor 2*
+
+**Year:** *2025*
+
+## Project Description
+>provide a short description of the main goals
+
+## Zotero Library Path
+>Please provide the link to the Zotero group here or include a `Bib`-File in the `report` folder
+
+## Instructions
+>If someone wants to re-run your study, how do they do that? Give instructions here.
+
+## Overview of Folder Structure 
+
+```
+│projectdir          <- Project's main folder. It is initialized as a Git
+│                       repository with a .gitignore file.
+│
+├── experiment       <- Files for running the experiment
+|
+├── notebooks        <- Pluto, Jupyter, Weave or any other mixed media notebooks.*
+|
+├── papers           <- Materials related to paper, publishing
+|
+├── _research        <- WIP scripts, code, notes, comments,
+│   |                   to-dos and anything in an alpha state.
+│
+├── plots            <- All exported plots go here, best in date folders.
+|   |                   Note that to ensure reproducibility it is required that all plots can be
+|   |                   recreated using the plotting scripts in the scripts folder.
+|
+│
+├── scripts          <- Various scripts, e.g. simulations, plotting, analysis,
+│   │                   The scripts use the `src` folder for their base code.
+│
+├── src              <- Source code for use in this project. Contains functions,
+│                       structures and modules that are used throughout
+│                       the project and in multiple scripts.
+│
+├── test             <- Folder containing tests for `src`.
+│   └── runtests.jl  <- Main test file
+│
+├── README.md        <- Top-level README.
+|
+├── .gitignore       <- produced by Dr. Watson
+│
+├── (Manifest.toml)  <- Contains full list of exact package versions used currently.
+|── (Project.toml)   <- Main project file, allows activation and installation. Produced by Dr. Watson
+|── (project_project_template.toml)   <-  This is for a content-wise description of your exepriment. 
+                                          Change "project_template" in the filename to your project name. 
+                        
+```
+
+\*Instead of having a separate *notebooks* folder, you can also delete it and integrate your notebooks in the scripts folder. However, notebooks should always be marked by adding `nb_` in front of the file name.
+
+
+# template_project - produced by Dr. Watson
 
 This code base is using the [Julia Language](https://julialang.org/) and
 [DrWatson](https://juliadynamics.github.io/DrWatson.jl/stable/)