Skip to content
Snippets Groups Projects
Commit ae015cf9 authored by Vaibhav Agrawal's avatar Vaibhav Agrawal
Browse files

Update README.rst

parent 910218da
No related branches found
No related tags found
No related merge requests found
# Flatland ========
Flatland
========
...@@ -14,48 +15,71 @@ ...@@ -14,48 +15,71 @@
Multi Agent Reinforcement Learning on Trains Multi Agent Reinforcement Learning on Trains
Getting Started
===============
Generate Docs Generate Docs
-------------- --------------
| The docs have a lot more details about how to interact with this codebase.
| **TODO**: Mohanty to add atleast a neat outline herefor the contents to the docs here.
.. code-block:: bash The docs have a lot more details about how to interact with this codebase.
git clone git@gitlab.aicrowd.com:flatland/flatland.git **TODO**: Mohanty to add atleast a neat outline herefor the contents to the docs here ::
cd flatland
pip install -r requirements_dev.txt
* Linux and macOS git clone git@gitlab.aicrowd.com:flatland/flatland.git
cd flatland
pip install -r requirements_dev.txt
.. code-block:: bash * On, Linux and macOS ::
make docs make docs
* Windows * On, Windows ::
.. code-block:: bash python setup.py develop (or)
python setup.py install
python setup.py develop (or) python make_docs.py
python setup.py install
python make_docs.py
Features Features
-------- --------
* TODO TODO
Installation Installation
-------- ============
| To install the **Stable Release** of flatland, run this command in your terminal:
Stable Release
.. code-block:: bash --------------
pip install flatland-rl To install flatland, run this command in your terminal ::
pip install flatland-rl
This is the preferred method to install flatland, as it will always install the most recent stable release.
If you don’t have `pip <https://pip.pypa.io/en/stable/>`_ installed, this `Python installation guide <https://docs.python-guide.org/starting/installation/>`_ can guide you through the process.
From Sources
------------
The sources for flatland can be downloaded from the `Gitlab repo <https://gitlab.aicrowd.com/flatland/flatland>`_.
You can clone the public repository ::
$ git clone git@gitlab.aicrowd.com:flatland/flatland.git
Once you have a copy of the source, you can install it with ::
$ python setup.py install
Usage
=====
To use flatland in a project ::
import flatland
Authors Authors
...@@ -67,4 +91,5 @@ Authors ...@@ -67,4 +91,5 @@ Authors
* Erik Nygren <erik.nygren@sbb.ch> * Erik Nygren <erik.nygren@sbb.ch>
* Adrian Egli <adrian.egli@sbb.ch> * Adrian Egli <adrian.egli@sbb.ch>
<please fill yourself in> <please fill yourself in>
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment