From 922fdb47b4f3a11fcaf522d819fc10f38a416fe5 Mon Sep 17 00:00:00 2001
From: Rishi Sharma <rishi.sharma@epfl.ch>
Date: Fri, 21 Jan 2022 13:40:16 +0100
Subject: [PATCH] Improve Documentation
---
README.rst | 13 ++++++++-----
1 file changed, 8 insertions(+), 5 deletions(-)
diff --git a/README.rst b/README.rst
index 2113ef8..d1ef408 100644
--- a/README.rst
+++ b/README.rst
@@ -8,14 +8,17 @@ Setting up decentralizepy
* Fork the repository.
* Clone and enter your local repository.
-* Check if you have python >= 3.8.
+* Check if you have ``python>=3.8``.
* (Optional) Create and activate a virtual environment.
-* Update pip::
+* Update pip. ::
+
pip3 install --upgrade pip
pip install --upgrade pip
-* Install decentralizepy for development::
- pip3 install --editable .\[dev\]
+* Install decentralizepy for development/ ::
+
+ pip3 install --editable .\[dev\]
+
Node
----
* The Manager. Optimizations at process level.
@@ -34,7 +37,7 @@ Graph
Mapping
-------
-* Naming. The globally unique ids of the processes <-> machine_id, local_rank
+* Naming. The globally unique ids of the ``processes <-> machine_id, local_rank``
Sharing
-------
--
GitLab