From ac40db597466469a37713a3e8e0ba6aa9fc92fa3 Mon Sep 17 00:00:00 2001
From: Chris Reinke <chris.reinke@inria.fr>
Date: Fri, 29 Oct 2021 15:21:37 +0200
Subject: [PATCH] updated errors in readme

---
 readme.md | 23 ++++++++++++++++-------
 1 file changed, 16 insertions(+), 7 deletions(-)

diff --git a/readme.md b/readme.md
index 8c3b24a..e6eb567 100644
--- a/readme.md
+++ b/readme.md
@@ -1,24 +1,33 @@
-# Xi-learning
+# Xi-Learning
 
-Source Code for the Paper "Xi-learning: Successor Feature Transfer Learning for General Reward Functions".
+Source code of the Xi-Learning framework and its experimental evaluation for the paper: [Xi-learning: Successor Feature Transfer Learning for General Reward Functions](https://www.arxiv.org).
+
+Authors: [Chris Reinke](https://www.scirei.net/), [Xavier Alameda-Pineda](http://xavirema.eu/)
 
-Authors: Chris Reinke, Xavier Alameda-Pineda
 Copyright: INRIA, 2021
+
 License: GNU General Public License v3.0 or later
 
+<!-- ## Introduction
+
+Xi-Learning is a Reinforcement Learning framework for Transfer Learning between tasks that differ in their reward functions.
+It is based on the concept of Successor Features.
+Xi agents learn  -->
+
+
 ## Setup
 
 Requirements:
- - >= Python 3.6.
+ - Python 3.6 or higher.
  - Linux (developed under Ubuntu 18.04) or MacOS.
  - Several python package are required which will be automatically installed during the setup.
 
-To run the experiments the xi_learning package must be installed.
-It is recommended to install the package in developer mode (*-e*), so that changes to the source code can be directly applied:
+To run the experiments the xi_learning python package must be installed.
+It is recommended to install the package in developer mode (*-e*), so that changes to the source code can be directly used without the need to reinstall the package:
 
 `pip install -e .`
 
-For loading the results with our DataLoader widget in Jupyter notebook, run the following command.
+To be able to load the results with our DataLoader widget in Jupyter notebook, run the following command.
 (Note: The GUI is currently only tested for Jupyter notebooks. For Jupyterlab, other installation procedures are necessary.)
 
 `jupyter nbextension enable --py --sys-prefix qgrid`
-- 
GitLab