From b6619f4c42cd296b0aa37480552d9ee3fc8ef9ab Mon Sep 17 00:00:00 2001
From: Stefano Pigozzi <me@steffo.eu>
Date: Thu, 21 Oct 2021 05:00:09 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=97=92=20Add=20install=20steps=20(closes?=
 =?UTF-8?q?=20#58)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

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

diff --git a/README.md b/README.md
index 6322f6b..3b4b804 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,49 @@ The goal of this project is developing a platform that universities can use to *
 papers_.
 
 
+## Installation
+
+### Requirements
+
+- Internet connection
+- Any Linux server
+- [Docker][what-is-docker]
+- [Docker Compose][what-is-compose]
+
+[what-is-docker]: https://www.docker.com/
+
+[what-is-docker-compose]: https://docs.docker.com/compose/
+
+
+### Steps
+
+1. Create a new directory named `sophon` on your machine and enter it:
+   ```console
+   # mkdir sophon
+   # cd sophon
+   ```
+
+2. Pull the `ghcr.io/steffo99/sophon-jupyter` Docker image:
+   ```console
+   # docker pull ghcr.io/steffo99/sophon-jupyter
+   ```
+
+3. Download the `docker-compose.yml` file from this repository:
+   ```console
+   # wget "https://raw.githubusercontent.com/Steffo99/sophon/main/docker-compose.yml"
+   ```
+
+4. Configure the `docker-compose.yml` file following the instructions written in the comments:
+   ```console
+   # vim docker-compose.yml
+   ```
+
+5. Start the Docker containers:
+   ```console
+   # docker compose up -d
+   ```
+
+
 ## Structure
 
 The project consists of four parts: