Skip to content
Snippets Groups Projects
Commit b8c79389 authored by maljx's avatar maljx
Browse files

fixed layout of README file

parent 74e60938
No related branches found
No related tags found
No related merge requests found
...@@ -9,7 +9,7 @@ flatland ...@@ -9,7 +9,7 @@ flatland
:alt: Test Running :alt: Test Running
.. image:: https://gitlab.aicrowd.com/flatland/flatland/badges/master/coverage.svg .. image:: https://gitlab.aicrowd.com/flatland/flatland/badges/master/coverage.svg
:target: https://gitlab.aicrowd.com/flatland/flatland/pipelines :target: https://gitlab.aicrowd.com/flatland/flatland/pipelines
:alt: Test Coverage :alt: Test Coverage
...@@ -20,20 +20,27 @@ Generate Docs ...@@ -20,20 +20,27 @@ Generate Docs
| The docs have a lot more details about how to interact with this codebase. | 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. | **TODO**: Mohanty to add atleast a neat outline herefor the contents to the docs here.
.. code-block:: bash .. code-block:: bash
Linux and macOS setup
git clone git@gitlab.aicrowd.com:flatland/flatland.git
cd flatland
pip install -r requirements_dev.txt
make docs
Windows Setup
git clone git@gitlab.aicrowd.com:flatland/flatland.git git clone git@gitlab.aicrowd.com:flatland/flatland.git
cd flatland cd flatland
pip install -r requirements_dev.txt pip install -r requirements_dev.txt
python setup.py develop
python make_docs.py * Linux and macOS
.. code-block:: bash
make docs
* Windows
.. code-block:: bash
python setup.py develop (or)
python setup.py install
python make_docs.py
Features Features
-------- --------
...@@ -45,4 +52,5 @@ Authors ...@@ -45,4 +52,5 @@ Authors
* Sharada Mohanty <mohanty@aicrowd.com> * Sharada Mohanty <mohanty@aicrowd.com>
* Giacomo Spigler <giacomo.spigler@gmail.com> * Giacomo Spigler <giacomo.spigler@gmail.com>
* Mattias Ljungström <ml@mljx.io> * Mattias Ljungström <ml@mljx.io>
<please fill yourself in>
\ No newline at end of file <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