Skip to content
Snippets Groups Projects
Commit 28d0f3a2 authored by u214892's avatar u214892
Browse files

#71 docuemntation for getting_started

parent 5f8e9169
No related branches found
No related tags found
No related merge requests found
...@@ -70,6 +70,12 @@ Ready to contribute? Here's how to set up `flatland` for local development. ...@@ -70,6 +70,12 @@ Ready to contribute? Here's how to set up `flatland` for local development.
$ cd flatland/ $ cd flatland/
$ python setup.py develop $ 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:: 4. Create a branch for local development::
$ git checkout -b name-of-your-bugfix-or-feature $ git checkout -b name-of-your-bugfix-or-feature
......
...@@ -47,6 +47,15 @@ Online Docs ...@@ -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/>`_ 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 Generate Docs
......
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