From daf209926716ef3277df8f2615ee9cf8cb27b382 Mon Sep 17 00:00:00 2001
From: Kremitzl <christian.kremitzl@uni-bamberg.de>
Date: Tue, 17 Dec 2019 18:26:56 +0000
Subject: [PATCH 1/2] =?UTF-8?q?=E2=80=9EREADME.md=E2=80=9C=20=C3=A4ndern?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 17849be..b4e1dc8 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# OnPoint
+# onPoint
 
 ## Installation
 

From ce0973def547df486441d97e83ceea36b4b2babb Mon Sep 17 00:00:00 2001
From: Florian Knoch <florian.knoch@stud.uni-bamberg.de>
Date: Tue, 17 Dec 2019 21:09:31 +0100
Subject: [PATCH 2/2] Describe how to include onPoint in other projects

---
 README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 44 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index b4e1dc8..9d022cd 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,49 @@
 
 ## Installation
 
-You have to have python3 and pandoc installed.
-  
+This program is meant to be used as a git submodule of your actual presentation project, therefore you need to add it:
+
+	$ git submodule add -b release git@path-to-onpoint.git
+
+Make sure to have python3 and pandoc installed.
+Next, we can install all requirements:
+
 	$ cd onpoint
 	$ pip3 install -r requirements.txt
+
+## The Project Structure
+
+We recommend you to structure your project directory like this:
+
+	├── images
+	├── layouts
+	│   ├── default.html
+	│   ├── root.html
+	│   └── titlepage.html
+	├── meta.yml
+	├── onpoint
+	│   ├── main.py
+	│   ├── README.md
+	│   └── requirements.txt
+	├── slides
+	│   ├── chapter1.de.md
+	│   ├── chapter1.en.md
+	│   ├── chapter2.de.md
+	│   └── chapter2.en.md
+	├── slides.de.html
+	├── slides.en.html
+	├── slides.yml
+	└── styles
+      └── style.css
+
+* `onpoint` is where this program lives.
+* In `layouts`, you can create custom templates for your slides.
+* `meta.yml` is there to add language-specific meta information (like title internationalization).
+* `slides.yml` will contain a list of all chapters to be included. Their content is expected to live in files inside the `slides` folder.
+* You can store your usual web resources in the folders `styles` and `images`.
+
+## Updating onPoint
+
+In order to update the version of onPoint in an existing project, run the following command:
+
+	$ git submodule update --recursive --remote
\ No newline at end of file