From dbeb1516d201246cbf8847343ea62df6cb3f4799 Mon Sep 17 00:00:00 2001
From: Stefano Pigozzi <me@steffo.eu>
Date: Tue, 3 Aug 2021 03:17:31 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=97=92=20Add=20a=20better=20README?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f44d684..d780ac0 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,41 @@
 # Sophon
 
-Django and React project for dataset collection
+_A research hub for universities_
+
+## Goal
+
+The goal of this project is developing a platform that universities can use to **host** and **share** their _datasets_, _research projects_ and resulting 
+_papers_.
+
+## Development
+
+The project consists of a **single-page-app with React** on the frontend and a **web API with Django Rest Framework** on the backend.
+
+### Progress
+
+Development progress is tracked on [issue #20](https://github.com/Steffo99/sophon/issues/20).
+
+Development is currently focusing on the **backend**.
+
+### Tools
+
+Sophon is being developed using [IntelliJ IDEA Ultimate](https://www.jetbrains.com/idea/): its metadata is included in the `.idea` directory so that the code style and tools are consistent across all machines used during the development.
+
+### Commits
+
+Commits names are prefixed with a variant of [Gitmoji](https://gitmoji.dev/) which follows roughly this legend:
+
+- ✨ New feature
+- 🔧 Refactor or tweak
+- 🐛 Bug fix
+- 🧹 Cleanup
+- 📔 Documentation
+- 🗒 Readme
+- ⬆ Dependency update
+- 📦 Packaging
+- 🔨 Tool update
+- 🚧 Work in progress
+
+### People
+
+The project is currently being developed by [Stefano Pigozzi](https://github.com/Steffo99/), under the tutoring of [Francesco Faenza](https://github.com/Cicciodev) and [Claudia Canali](https://weblab.ing.unimore.it/people/canali/).