From d508a3718dd693daba9e7f99107b7157b30d6a18 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Maxime=20Ch=C3=A9ramy?= <maxime@cheramy.org>
Date: Fri, 25 Feb 2022 23:46:01 +0100
Subject: [PATCH] Update README

---
 README.md | 39 ++++++++++++++++++++++++++++++++++-----
 1 file changed, 34 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 735d31c..6538e41 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,39 @@
-# SimSo
+# SimSo - Simulation of Multiprocessor Scheduling with Overheads
 
-SimSo is a scheduling simulator designed for the study of real-time scheduling algorithms.
+SimSo is a scheduling simulator for real-time multiprocessor architectures that takes into account some scheduling overheads (scheduling decisions, context switches) and the impact of caches through statistical models. Based on a Discrete-Event Simulator (SimPy), it allows quick simulations and a fast prototyping of scheduling policies using Python. Currently, [more than 25 popular schedulers are available](https://maximecheramy.github.io/simso/). 
 
-- Project website: http://projects.laas.fr/simso/
-- Documentation: http://projects.laas.fr/simso/doc/
+## Documentation
 
-You can find its graphical user interface here: https://github.com/MaximeCheramy/simso-gui
+You can access the documentation here: [Documentation of SimSo](https://maximecheramy.github.io/simso/). You will find tutorials that should help you to start.
+
+## Download
+
+SimSo is divided in 2 components: the core and the graphical user interface.
+
+If you have Python installed (and PyQt4 for the GUI), you can install simso using the tool pip: pip install simso simsogui. This has the advantage to work on Linux, Mac OS and Windows.
+
+The source code can also be found on PyPI and GitHub:
+
+- SimSo (Python module): https://pypi.python.org/pypi/simso/
+- Graphical User Interface: https://pypi.python.org/pypi/simsogui/
+
+- SimSo (Python module): https://github.com/MaximeCheramy/simso
+- Graphical User Interface: https://github.com/MaximeCheramy/simso-gui
+
+You can also find a web version of SimSo here: [https://github.com/MaximeCheramy/simso-web](https://github.com/MaximeCheramy/simso-web).
+
+## Publications
+
+The general presentation of the tool can be found in the following paper published at WATERS:
+
+SimSo: A Simulation Tool to Evaluate Real-Time Multiprocessor Scheduling Algorithms. Maxime Chéramy, Pierre-Emmanuel Hladik and Anne-Marie Déplanche. In proceedings of the 5th International Workshop on Analysis Tools and Methodologies for Embedded and Real-time Systems (WATERS). July 2014.
+
+How to cite:
+
+```
+@inproceedings{cheramy2014, Author = {Ch\'eramy, Maxime and Hladik, Pierre-Emmanuel and D\'eplanche, Anne-Marie}, Booktitle = {Proc. of the 5th International Workshop on Analysis Tools and Methodologies for Embedded and Real-time Systems}, Series = {WATERS}, Title = {SimSo: A Simulation Tool to Evaluate Real-Time Multiprocessor Scheduling Algorithms}, Year = {2014}}
+```
+
+## License
 
 This is a free software available under the CeCILL license (GPL compatible).