From b8c79389a7b8eab9b5bd54b8266f235b5a1c2465 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mattias=20Ljungstr=C3=B6m?= <ml@mljx.io>
Date: Tue, 9 Apr 2019 14:10:07 +0200
Subject: [PATCH] fixed layout of README file
---
README.rst | 32 ++++++++++++++++++++------------
1 file changed, 20 insertions(+), 12 deletions(-)
diff --git a/README.rst b/README.rst
index a105fc67..d29f9142 100644
--- a/README.rst
+++ b/README.rst
@@ -9,7 +9,7 @@ flatland
:alt: Test Running
.. image:: https://gitlab.aicrowd.com/flatland/flatland/badges/master/coverage.svg
:target: https://gitlab.aicrowd.com/flatland/flatland/pipelines
- :alt: Test Coverage
+ :alt: Test Coverage
@@ -20,20 +20,27 @@ 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
- Linux and macOS setup
- git clone git@gitlab.aicrowd.com:flatland/flatland.git
- cd flatland
- pip install -r requirements_dev.txt
- make docs
+ .. code-block:: bash
- Windows Setup
git clone git@gitlab.aicrowd.com:flatland/flatland.git
cd flatland
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
--------
@@ -45,4 +52,5 @@ Authors
* Sharada Mohanty <mohanty@aicrowd.com>
* Giacomo Spigler <giacomo.spigler@gmail.com>
* Mattias Ljungström <ml@mljx.io>
-<please fill yourself in>
\ No newline at end of file
+
+<please fill yourself in>
--
GitLab