some readme drafts

.github/workflows/docs.yaml

@@ -40,25 +40,25 @@ jobs:
  make clean
  make docs
 
- - name: Pull latest gh-pages
+ - name: Pull latest gh_pages
  if: (contains(github.ref, 'development') || contains(github.ref, 'main'))
  run: |
  cd ..
- git clone https://github.com/${{ github.repository }}.git --branch gh-pages --single-branch gh-pages
+ git clone https://github.com/${{ github.repository }}.git --branch gh_pages --single-branch gh_pages
 
- - name: Copy new docs into gh-pages
+ - name: Copy new docs into gh_pages
  if: (contains(github.ref, 'development') || contains(github.ref, 'main'))
  run: |
  branch_name=${GITHUB_REF##*/}
- cd ../gh-pages
+ cd ../gh_pages
  rm -rf $branch_name
  cp -r ../${{ env.name }}/docs/build/html $branch_name
 
- - name: Push to gh-pages
+ - name: Push to gh_pages
  if: (contains(github.ref, 'development') || contains(github.ref, 'main'))
  run: |
  last_commit=$(git log --pretty=format:"%an: %s")
- cd ../gh-pages
+ cd ../gh_pages
  branch_name=${GITHUB_REF##*/}
  git add $branch_name/
  git config --global user.name 'Github Actions'

README.md

@@ -33,20 +33,60 @@
 
 **JAX-Based implementations of DQN, PPO, and SAC**
 
-## Setup
+## Installation
 
-1. **Installation**: You can install ARLBench using `pip`:
+There are currently two different ways to install ARLBench:
+
+<details>
+<summary>After acceptance: PyPI</summary>
+You can install ARLBench using `pip`:
 
 ```bash
 pip install arlbench
 ```
 
-TODO insert instructions to use SMAC/PBT2 etc
+If you want to use envpool environments (not currently supported for Mac!), instead choose:
+```bash
+pip install arlbench[envpool]
+```
+
+</details>
 
-2. **Usage**:
+<details>
+<summary>From source: GitHub</summary>
+First, you need to clone the ARLBench reopsitory:
+
+```bash
+git clone [email protected]:automl/arlbench.git
+cd arlbench
+```
+
+We recommend to create a virtual environment for the installation:
+```bash
+conda create -n arlbench python=3.10
+```
+
+Then you can install the benchmark. For the base version, use:
+```bash
+make install
+```
+
+For the envpool functionality (not available on Mac!), instead use:
+```bash
+make install-envpool
+```
+</details>
 
 ## Quickstart
 
+ARLBench functions similarly to a RL environment itself: you create it, initialize it via a 'reset' function and then run it using 'step':
+```python
+from arlbench import AutoRLEnv
+
+env = AutoRLEnv(cfg.autorl)
+TODO
+```
+
 ### Use the CLI
 
 ### Use the AutoRL environment