From f89778c9fa2cc8ec486ee4900448d889ca401ac8 Mon Sep 17 00:00:00 2001
From: Dipam Chakraborty <dipamc77@gmail.com>
Date: Fri, 3 Sep 2021 23:58:22 +0530
Subject: [PATCH] add gym readme

---
 deepracer-gym/README.md | 34 +++++++++++++++++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

diff --git a/deepracer-gym/README.md b/deepracer-gym/README.md
index e3bcb7a..0098423 100644
--- a/deepracer-gym/README.md
+++ b/deepracer-gym/README.md
@@ -1 +1,33 @@
-# Instructions for using the Deepracer Gym Environment
\ No newline at end of file
+# Deepracer Gym Environment
+
+AWS Deepracer is a service hosted with AWS Robomaker platform. To make it easy for partcipants, we are releasing a gym environment for Deepracer. The simulator runs by starting a Docker container that runs the simulator and using a network connection with ZeroMQ server to provide a Gym interface.
+
+Run these to quickly get started.
+
+```bash
+# Install docker if needed
+sudo snap install docker
+
+# Install the Deepracer Gym Environment
+pip install -e ./deepracer-gym
+
+# Start the Deepracer docker container
+source deepracer-gym/start_deepracer_docker.sh
+# This might take a while to download and start
+
+# Wait until the terminal says "===Waiting for gym client==="
+
+# Open a new terminal
+# Run a random actions agent with Deepracer Gym
+python deepracer-gym/random_actions_example.py
+
+# Stop the docker container once done
+source deepracer-gym/stop_deepracer_docker.sh
+```
+
+# Resources required
+
+We recommend using 3 CPUs and 6 GB or RAM for the simulator.
+
+If you want to reduce these, modify the flags `--cpus="3"` and `--memory="6g"` in `start_deepracer_docker.sh`.
+
-- 
GitLab