Merge branch 'master' into introduce_ReadTheDocs

README.md

@@ -6,8 +6,16 @@ This is a collection of tutorials and examples to document, explain and illustra
 
 ## Getting started
 
-To get started basically follow these simple steps, which we will take you through in
-the following:
+To get going with the tutorials you can either start directly in your browser or get
+ a local copy and experiment offline on your machine.
+
+ ### Quick start in current browser session
+
+To start working in the notebooks directly in the browser, click [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/PTB-PSt1/PyDynamic_tutorials/master).
+
+ ### Get a local copy to work offline
+
+To get started on your local machine, follow these simple steps:
 
 1. Clone the repository, if you haven't already
 1. Set up a virtual environment for PyDynamic_tutorials
@@ -17,7 +25,7 @@ the following:
 1. Browse the various examples in the repository, alter and execute the code right in
    your browser
 
-### 1. Clone the repository
+#### 1. Clone the repository
 
 ```shell
 $ git clone https://github.com/PTB-PSt1/PyDynamic_tutorials.git
@@ -27,7 +35,7 @@ Receiving objects: 100% (3/3), done.
 $
 ```
 
-### 2. Set up a virtual environment
+#### 2. Set up a virtual environment
 
 On your command line/powershell execute:
 
@@ -40,7 +48,7 @@ This will create a subfolder _PyDynamic_tutorial_venv_ and prepare a fully
 self-contained Python environment, which we can activate in the next step and install
 further Python packages without polluting or disturbing your system environment.
 
-### 3. Install the dependencies
+#### 3. Install the dependencies
 
 First we activate the previously created environment before we then install the required
 dependencies in two steps, because we are utilizing `pip-tools` to ensure you get a
@@ -60,7 +68,7 @@ webencodings-0.5.1
 $
 ```
 
-### 4. Start the notebook server
+#### 4. Start the notebook server
 
 Now from the environment we created previously, start up the Jupyter Notebook server.
 
@@ -71,13 +79,13 @@ $ jupyter notebook
 [I 13:01:24.790 NotebookApp] http://localhost:8888/?token=f368c552e042d48d46ff4c8a094448d0e7681790b0719215
 ```
 
-### 5. Go to localhost:8888
+#### 5. Go to localhost:8888
 
 Usually a browser window will have opened automatically at this point. Otherwise just
 open one yourself and navigate to the printed URL in the console, in our case
 `http://localhost:8888/?token=f368c552e042d48d46ff4c8a094448d0e7681790b0719215`.
 
-### 6. Browse the various examples
+#### 6. Browse the various examples
 
 You should see something like the following:
 

requirements.txt

@@ -0,0 +1,2 @@
+-r requirements/requirements.txt
+-r requirements/requirements-dev.txt