From 2cd9c052d8b18fa901d87836c80eaaa44d254ff8 Mon Sep 17 00:00:00 2001
From: Patrik Keller <git@pkel.dev>
Date: Mon, 25 Mar 2024 11:17:31 +0100
Subject: [PATCH] Add small README for Rust-based gym

---
 gym/cpr_gym_rs/README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)
 create mode 100644 gym/cpr_gym_rs/README.md

diff --git a/gym/cpr_gym_rs/README.md b/gym/cpr_gym_rs/README.md
new file mode 100644
index 00000000..98467055
--- /dev/null
+++ b/gym/cpr_gym_rs/README.md
@@ -0,0 +1,10 @@
+```shell
+# activate Python venv
+. ../../_venv/bin/activate
+
+# build and install the package / gym
+maturin develop
+
+# start a simple training run
+python -m rl_zoo3.train --env 'FC16SSZwPT-v0' --env-kwargs alpha:0.33 gamma:1.0 --gym-packages cpr_gym_rs --algo dqn --conf hyperparams/dqn.yml --eval-freq 0 -P
+```