diff --git a/README.rst b/README.rst index 2113ef8bc7ae93cf7798b7b74fea3fdb115fd781..d1ef40864b9177ef2103704fc24b552d0209014f 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 -------