From 28d0f3a2795a60aff71d28a45053e5526e418cf2 Mon Sep 17 00:00:00 2001
From: u214892 <u214892@sbb.ch>
Date: Thu, 20 Jun 2019 09:33:56 +0200
Subject: [PATCH] #71 docuemntation for getting_started
---
CONTRIBUTING.rst | 6 ++++++
README.rst | 9 +++++++++
2 files changed, 15 insertions(+)
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 65971d32..a0bc61a4 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -70,6 +70,12 @@ Ready to contribute? Here's how to set up `flatland` for local development.
$ cd flatland/
$ python setup.py develop
+ You can also use the virtual environment created by the getting_started scripts:
+
+ getting_started/run_notebooks.bat
+ getting_started/run_notebooks.sh
+
+
4. Create a branch for local development::
$ git checkout -b name-of-your-bugfix-or-feature
diff --git a/README.rst b/README.rst
index a626dcb8..4d0cb2ab 100644
--- a/README.rst
+++ b/README.rst
@@ -47,6 +47,15 @@ Online Docs
The documentation for the latest code on the master branch is found at `http://flatland-rl-docs.s3-website.eu-central-1.amazonaws.com/ <http://flatland-rl-docs.s3-website.eu-central-1.amazonaws.com/>`_
+Run Notebooks with Examples with one Click
+------------------------------------------
+Under getting_started, there are two scripts
+
+ getting_started/run_notebooks.bat
+ getting_started/run_notebooks.sh
+
+They require git and Python>=3.6 installed with venv (python3-venv has to be installed under Linux).
+They create a virtual environment, install Flatland and all dependencies into into and start they Jupyter notebooks in your browser.
Generate Docs
--
GitLab