From c89d5d5fb44cd4f11971cc21111deb58b867e12b Mon Sep 17 00:00:00 2001
From: tillraab <till.raab@student.uni-tuebingen.de>
Date: Tue, 10 Jan 2023 08:34:16 +0100
Subject: [PATCH] creates README.md describing workflow in gits

---
 README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)

diff --git a/README.md b/README.md
index e69de29..a5191de 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,40 @@
+# Chirp detection - GP2023
+## Git-Repository and commands
+
+- Go to the [Bendalab Git-Server](https://whale.am28.uni-tuebingen.de/git/) (https://whale.am28.uni-tuebingen.de/git/)
+- Create your own account (and tell me ;D)
+  * I'll invite you the repository
+- Clone the repository
+- 
+```sh
+git clone https://whale.am28.uni-tuebingen.de/git/raab/GP2023_chirp_detection.git
+```
+
+## Basic git commands
+
+- pull changes in git
+```shell
+git pull origin <branch>
+```
+- commit chances
+```shell
+git commit -m '<explaination>' file  # commit one file
+git commit -a -m '<explaination>'    # commit all files
+```
+- push commits
+```shell
+git push origin <branch>
+```
+
+## Branches
+Use branches to work on specific topics (e.g. 'algorithm', 'analysis', 'writing', ore even more specific ones) and merge
+them into Master-Branch when it works are up to your expectations.
+
+The "master" branch should always contain a working/correct version of your project.
+
+- Create/change into branches
+```shell
+git checkout -b <new branch>
+git checkout <existing branch>
+```
+