Mephisto example projects launching instruction

examples/README.md

@@ -5,4 +5,71 @@
 -->
 
 # Examples
-The Mephisto example folders within contain some sample starter code and tasks to demonstrate potential workflows for setting up and working on new tasks. 
+The Mephisto example folders within contain some sample starter code and tasks to demonstrate potential workflows for setting up and working on new tasks.
+
+Mephisto Tasks can be launched (each run is called TaskRun) with a single `docker-compose` command (you will need to have Docker [installed](https://docs.docker.com/engine/install/).)
+
+Let's launch Mephisto example tasks, starting from the easiest one
+
+---
+
+#### 1. Simple HTML-based task
+
+A simple project with HTML-based UI task template [simple_static_task](/examples/simple_static_task)
+
+- Default config file: [/examples/simple_static_task/hydra_configs/conf/example.yaml]
+- Launch command:
+  ```shell
+  docker-compose -f docker/docker-compose.dev.yml run \
+      --build \
+      --publish 3001:3000 \
+      --rm mephisto_dc \
+      python /mephisto/examples/simple_static_task/static_test_script.py
+  ```
+- Browser page (for the first task unit): [http://localhost:3001/?worker_id=x&assignment_id=1](http://localhost:3001/?worker_id=x&assignment_id=1)
+- Browser page should display an image, instruction, select and file inputs, and a submit button.
+
+---
+
+#### 2. Simple React-based task
+
+A simple project with React-based UI task template [static_react_task](/examples/static_react_task)
+
+- Default config file: [example.yaml](/examples/static_react_task/hydra_configs/conf/example.yaml).
+- Launch command:
+  ```shell
+  docker-compose -f docker/docker-compose.dev.yml run \
+      --build \
+      --publish 3001:3000 \
+      --rm mephisto_dc \
+      python /mephisto/examples/static_react_task/run_task.py
+  ```
+- Browser page (for the first task unit): [http://localhost:3001/?worker_id=x&assignment_id=1](http://localhost:3001/?worker_id=x&assignment_id=1).
+- Browser page should display an instruction line and two buttons (green and red).
+
+---
+
+#### 3. Task with dynamic input
+
+A more complex example featuring worker-generated dynamic input: [mnist](/examples/remote_procedure/mnist).
+
+- Default config file: [launch_with_local.yaml](/examples/remote_procedure/mnist/hydra_configs/conf/launch_with_local.yaml).
+- Launch command:
+  ```shell
+  docker-compose -f docker/docker-compose.dev.yml run \
+      --build \
+      --publish 3001:3000 \
+      --rm mephisto_dc \
+      apt install curl && \
+      pip install grafana torch pillow numpy && \
+      mephisto metrics install && \
+      python /mephisto/examples/remote_procedure/mnist/run_task.py
+  ```
+- Browser page (for the first task unit): [http://localhost:3001/?worker_id=x&assignment_id=1](http://localhost:3001/?worker_id=x&assignment_id=1).
+- Browser page should display instructions and a layout with 3 rectangle fields for drawing numbers with a mouse, each field having inputs at the bottom.
+
+---
+
+# Your Mephisto project
+
+To read on steps for creating your own custom Mephisto task, please refer to README in the main Mephisto repo.