diff --git a/Setup/README.md b/Setup/README.md
index 610b86b1fa71f55aedc6e171ec75f0d085bf24ad..121d3b1a82057536c479f49fdbd2441f6fc6fb03 100644
--- a/Setup/README.md
+++ b/Setup/README.md
@@ -2,8 +2,11 @@
The setup constists of cloning this repository, installing `docker` and `Fenics`,
installing a few python modules that are not shipped with the standard
distributions and hack away.
+>>>
+**Note:**
This code assumes that you run Linux. It has not been tested on Windows.
It has been tested on `Debian Buster` and `Archlinux`.
+>>>
## Install docker
First, install `docker`, add yourelf to the `docker` group and run the
@@ -25,17 +28,20 @@ On `systemd`-based systems the daemon is started by running
sudo systemctl start docker
in the command line.
-
+>>>
+**Note:**
Note: If you don't have admistrative rights on your system, ask your systemadmin
to perform these steps for you. The user that wants to run `docker` needs to
be in the docker group. If you have added yourself to the docker group, don't
forget to log out and back in again.
-
+>>>
## Set up latest Fenix image in Docker
Pull the latest `Fenics` Docker image
docker pull quay.io/fenicsproject/stable:latest
+>>>
+**Note:**
This code as been tested on the latest docker version, which is as of October
2020 `Fenics 2019`.
The above explains how to pull the latest `Fenics` docker image.
@@ -53,7 +59,7 @@ for the latest 2019 tag and pull the 2019 image.
So assuming `2019.1.0` was the latest tag for the 2019 version, you would run
docker pull quay.io/fenicsproject/stable:2019.1.0
-
+>>>
## Create docker container named LDD-TPR with graphical display, share folder `pwd`
Move into the folder in which you cloned this directory and run
@@ -67,10 +73,11 @@ This directory is used to share files between your system and the docker
container. As you most likely will be programming on your system and only step
into the docker container to run a simulation, this is a necessary mechanism.
-Note: If you pulled a version of docker with a fixed tag, you need to adapt
+>>>
+**Note:** If you pulled a version of docker with a fixed tag, you need to adapt
the line `quay.io/fenicsproject/stable:latest` in the above to
`quay.io/fenicsproject/stable:2019.1.0`.
-
+>>>
If you want the container do be automatically deleted after exiting add `--rm` option.
If you have trouble with internet connection inside the container use
@@ -82,9 +89,9 @@ If you have trouble with internet connection inside the container use
From anywhere in the command line you can start the docker container by running
docker start LDD-TPR & docker exec -ti -u fenics LDD-TPR /bin/bash -l
-
+>>>
Tip: This command should be stored as a script or alias to not have to remember it.
-
+>>>
You should see a welcome message greeting you
```
# FEniCS stable version image
@@ -171,14 +178,12 @@ gain write access in `/home/fenics/shared`
## Usefull FEniCS Links
-The dolphin documentation including introductory documentation and demos
+- The dolphin documentation including introductory documentation and demos
can be found here
- [Dolphin (latest)](https://fenicsproject.org/docs/dolfin/latest/python/index.html)
-
- [Dolfin (2019.1.0)](https://fenicsproject.org/docs/dolfin/2019.1.0/python/index.html)
-
- [Dolfin (2018.1.0)](https://fenicsproject.org/docs/dolfin/2018.1.0/python/index.html)
+ - [Dolphin (latest)](https://fenicsproject.org/docs/dolfin/latest/python/index.html)
+ - [Dolfin (2019.1.0)](https://fenicsproject.org/docs/dolfin/2019.1.0/python/index.html)
+ - [Dolfin (2018.1.0)](https://fenicsproject.org/docs/dolfin/2018.1.0/python/index.html)
It is sometimes usefull to look at older docs to find the right answers.
@@ -187,17 +192,15 @@ An index for API references of dolphin (both cpp and python) can be found
[here](https://fenicsproject.org/docs/dolfin/).
The python API references can be found here
- [Dolphin (Fenics latest)](https://fenicsproject.org/docs/dolfin/latest/python/api.html)
-
- [Dolphin (Fenics 2019.1.0)](https://fenicsproject.org/docs/dolfin/2019.1.0/python/)
-
- [Dolphin (Fenics 2018.1.0)](https://fenicsproject.org/docs/dolfin/2018.1.0/python/index.html)
-
- [Dolphin (Fenics 2017.2.0)](https://fenicsproject.org/docs/dolfin/2017.2.0/python/programmers-reference/index.html)
-
+ - [Dolphin (Fenics latest)](https://fenicsproject.org/docs/dolfin/latest/python/api.html)
+ - [Dolphin (Fenics 2019.1.0)](https://fenicsproject.org/docs/dolfin/2019.1.0/python/)
+ - [Dolphin (Fenics 2018.1.0)](https://fenicsproject.org/docs/dolfin/2018.1.0/python/index.html)
+ - [Dolphin (Fenics 2017.2.0)](https://fenicsproject.org/docs/dolfin/2017.2.0/python/programmers-reference/index.html)
+>>>
+**Tip:**
It is sometimes necessary to have a look at older versions because some details
are better explained there and the docs have not been updated yet.
-
+>>>
- Fenics git in case you want to view the source files:
https://bitbucket.org/fenics-project/