From 30d7db092bc9b5ce0a5ef1b71db40ec170aa8740 Mon Sep 17 00:00:00 2001
From: danielle_rothermel <drotherm@fb.com>
Date: Wed, 9 Jun 2021 11:15:21 +0000
Subject: [PATCH] Cleanup the setup instructions
---
README.md | 72 +++++++++++++++++++++++++------------------------------
1 file changed, 33 insertions(+), 39 deletions(-)
diff --git a/README.md b/README.md
index eebf3f3..e2406ca 100644
--- a/README.md
+++ b/README.md
@@ -167,49 +167,43 @@ You can add your SSH Keys to your GitLab account by going to your profile settin
```
git clone git@gitlab.aicrowd.com:nethack/neurips-2021-the-nethack-challenge.git
```
-
-3. **Install** competition specific dependencies!
+
+3. **Verify you have dependencies** for the Nethack Learning Environment
+ NLE requires `python>=3.5`, `cmake>=3.14` to be installed and available both when building the
+ package, and at runtime.
+
+ On **MacOS**, one can use `Homebrew` as follows:
+
+ ``` bash
+ $ brew install cmake
```
- pip install -r requirements
+
+ On a plain **Ubuntu 18.04** distribution, `cmake` and other dependencies
+ can be installed by doing:
+
+ ```bash
+ # Python and most build deps
+ $ sudo apt-get install -y build-essential autoconf libtool pkg-config \
+ python3-dev python3-pip python3-numpy git flex bison libbz2-dev
+
+ # recent cmake version
+ $ wget -O - https://apt.kitware.com/keys/kitware-archive-latest.asc 2>/dev/null | sudo apt-key add -
+ $ sudo apt-add-repository 'deb https://apt.kitware.com/ubuntu/ bionic main'
+ $ sudo apt-get update && apt-get --allow-unauthenticated install -y \
+ cmake \
+ kitware-archive-keyring
```
-4. Run rollouts with a random agent with `python test_submission.py`.
-
-### For setting up the Nethack Learning Environment:
-
-NLE requires `python>=3.5`, `cmake>=3.14` to be installed and available both when building the
-package, and at runtime.
-
-On **MacOS**, one can use `Homebrew` as follows:
-
-``` bash
-$ brew install cmake
-```
-
-On a plain **Ubuntu 18.04** distribution, `cmake` and other dependencies
-can be installed by doing:
-
-```bash
-# Python and most build deps
-$ sudo apt-get install -y build-essential autoconf libtool pkg-config \
- python3-dev python3-pip python3-numpy git flex bison libbz2-dev
-
-# recent cmake version
-$ wget -O - https://apt.kitware.com/keys/kitware-archive-latest.asc 2>/dev/null | sudo apt-key add -
-$ sudo apt-add-repository 'deb https://apt.kitware.com/ubuntu/ bionic main'
-$ sudo apt-get update && apt-get --allow-unauthenticated install -y \
- cmake \
- kitware-archive-keyring
-```
-
-Afterwards it's a matter of setting up your environment. We advise using a conda
-environment for this:
+4. **Install** competition specific dependencies!
+ We advise using a conda environment for this:
+ ```bash
+ # Optional: Create a conda env
+ $ conda create -n nle_challenge python=3.8
+ $ conda activate nle_challenge
+ $ pip install -r requirements.txt
+ ```
-```bash
-$ conda create -n nle python=3.8
-$ conda activate nle
-$ pip install nle
-```
+5. Run rollouts with a random agent with `python test_submission.py`.
Find more details on the [original nethack repository](https://github.com/facebookresearch/nle)
--
GitLab