From 120f092a28a85f4524ad7f8893204fa9b3f4f57a Mon Sep 17 00:00:00 2001
From: MartinSchobben <schobbenmartin@gmail.com>
Date: Sun, 18 Aug 2024 16:37:33 +0200
Subject: [PATCH] add instructions

---
 README.md  | 43 +++++++++++++++++++++++++++++++++++++++++++
 README.qmd | 30 ++++++++++++++++++++++++++++++
 2 files changed, 73 insertions(+)
 create mode 100644 README.md
 create mode 100644 README.qmd

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0663848
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# Earth Observation Datascience
+
+This is a book on Earth Observation Datascience, consisting of common
+workflows in Python at the Department of Geodesy and Geoinformation at
+the TU Wien (Vienna Austria).
+
+The workflows comprise exercises that utilize remote sensing
+information, such as microwave backscattering from Sentinel-1 and
+visible range imagery from Sentinel-2.
+
+## Quarto
+
+This book is based on [Quarto](https://quarto.org/), a literate
+programming system for open-source scientific and technical documents.
+
+## Contribute
+
+You can contribute to this book by making a Pull Request. Make sure to
+include your workflow as an `qmd` file to the chapters directory while
+also creating an `environment.yml` file with the same name as quarto
+document. This should ensure that the python code can be executed as a
+standalone project. The `environment.yml`should be added to the
+`notebooks` directory. It is not necessary to include the `ipynb` file,
+as these will be generated automatically with GitHub actions. To include
+the chapter to the book include your filename to the `_quarto.yml`. If
+you have references, these should be included in the bibtex file
+(`chapters/references.bib`).
+
+To exemplify, adding `my_awesome_workflow.qmd` to the book requires the
+following steps:
+
+1)  Add `my_awesome_workflow.qmd` to the `chapters` directory
+2)  Add `my_awesome_workflow.yml`to the `notebooks` directory
+3)  Add `chapters/my_awesome_workflow.qmd` to the `chapters` list in the
+    `_quarto.yml` file
+4)  Add references to `chapter/references.bib`
+
+Don’t worry if your original file is an Jupyter Notebook. Jupyter
+notebooks can be easily converted to quarto files by using:
+
+``` {bash}
+quarto convert basics-jupyter.ipynb # converts to qmd
+```
diff --git a/README.qmd b/README.qmd
new file mode 100644
index 0000000..28591ab
--- /dev/null
+++ b/README.qmd
@@ -0,0 +1,30 @@
+---
+title: "Earth Observation Datascience"
+format: gfm
+---
+
+This is a book on Earth Observation Datascience, consisting of common workflows in Python at the Department of Geodesy and Geoinformation at the TU Wien (Vienna Austria).
+
+The workflows comprise exercises that utilize remote sensing information, such as microwave backscattering from Sentinel-1 and visible range imagery from Sentinel-2.
+
+## Quarto
+
+This book is based on [Quarto](https://quarto.org/), a literate programming system for open-source scientific and technical documents.
+
+## Contribute
+
+You can contribute to this book by making a Pull Request. Make sure to include your workflow as an `qmd` file to the chapters directory while also creating an `environment.yml` file with the same name as quarto document. This should ensure that the python code can be executed as a standalone project. The `environment.yml`should be added to the `notebooks` directory. It is not necessary to include the `ipynb` file, as these will be generated automatically with GitHub actions. To include the chapter to the book include your filename to the `_quarto.yml`. If you have references, these should be included in the bibtex file (`chapters/references.bib`).
+
+To exemplify, adding `my_awesome_workflow.qmd` to the book requires the following steps:
+
+1) Add `my_awesome_workflow.qmd` to the `chapters` directory
+2) Add `my_awesome_workflow.yml`to the `notebooks` directory
+3) Add `chapters/my_awesome_workflow.qmd` to the `chapters` list in the `_quarto.yml` file
+4) Add references to `chapter/references.bib`
+
+Don't worry if your original file is an Jupyter Notebook. Jupyter notebooks can be easily converted to quarto files by using:
+
+```{bash}
+quarto convert basics-jupyter.ipynb # converts to qmd
+```
+