From 1bb6b4eb1d89f1cd024dceea988b23d7f9c05015 Mon Sep 17 00:00:00 2001
From: Maarten Coonen <m.coonen@maastrichtuniversity.nl>
Date: Tue, 13 Aug 2024 11:05:57 +0200
Subject: [PATCH] Updated readme

---
 README.md | 62 ++++++++++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 54 insertions(+), 8 deletions(-)
 mode change 100644 => 100755 README.md

diff --git a/README.md b/README.md
old mode 100644
new mode 100755
index df55206..2791e7c
--- a/README.md
+++ b/README.md
@@ -1,10 +1,56 @@
-# The title
-This is the paragraph text. Lorem ipsum...
+This Jekyll blog theme is based on [The-MVM](https://github.com/the-mvm/the-mvm.github.io) (which on its turn is based on [Adam-blog](https://github.com/artemsheludko/adam-blog) and further adapted for the UB Maastricht use case.
 
-```python
-def my_function():
-  print("hello world")
-  
-my_function()
+
+## Run in production
+The theme fully compliant with [GitHub pages](https://pages.github.com/) and can be deployed using GitHub actions.
+
+## Run locally
+
+### Preparation
+Install the required packages as described in the [Jekyll docs](https://jekyllrb.com/docs/). For convenience, these are the steps in Ubuntu:
+
+Install Ruby
+```
+sudo apt-get install ruby-full build-essential zlib1g-dev
+```
+
+Aset up a gem installation directory for your user account
 ```
-Description of the code block
+echo '# Install Ruby Gems to ~/gems' >> ~/.bashrc
+echo 'export GEM_HOME="$HOME/gems"' >> ~/.bashrc
+echo 'export PATH="$HOME/gems/bin:$PATH"' >> ~/.bashrc
+source ~/.bashrc
+```
+
+Install Jekyll and Bundler
+```
+gem install jekyll bundler
+
+```
+
+### Install dependencies
+Install the site's dependencies from the Gemfile
+
+Change directory to the folder where this repo and the `Gemfile` is located.
+```
+cd /path/to/this/workdir
+```
+
+Install Gems from Gemfile with
+```
+bundle install
+```
+
+
+### Run site
+Start the site with
+```
+bundle exec jekyll serve
+```
+
+Access the site at http://localhost:4000
+
+
+
+## More details
+More details about Jekyll, the folder structure and workings can be found in the [MVM readme](https://github.com/the-mvm/the-mvm.github.io/blob/main/README.md).