From b2fe3491e27f53ebe708f35941711224020db5af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Florian=20Schr=C3=B6der?= <florian.schroeder@uni-bielefeld.de> Date: Thu, 18 Jan 2024 20:48:29 +0100 Subject: [PATCH] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3178ef82..a70fae97 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [API Docs](https://scs.pages.ub.uni-bielefeld.de/cocosy/overcooked-simulator) -The real-time overcooked simulation for a cognitive cooperative system +The real-time overcooked simulation for a cognitive cooperative system. **The name ist still work in progress and we will probably change it.** @@ -11,15 +11,15 @@ You have two options to install the environment. Either clone it and install it You need a Python 3.10 or higher environment. Either conda or PyEnv. ### Local Editable Installation -In your `repo`, `PyCharmProjects`` or similiar directory with the correct environment active: +In your `repo`, `PyCharmProjects` or similiar directory with the correct environment active: ```bash git clone https://gitlab.ub.uni-bielefeld.de/scs/cocosy/overcooked-simulator.git cd overcooked_simulator pip install -e . -``` +`` #### Run -You can use it in your Python code or run the main.py from the command line: +You can use it in your Python code or run the `main.py`from the command line: ```bash python3 overcooked_simulator/main.py ``` @@ -31,7 +31,7 @@ pip install overcooked-environment@git+https://gitlab.ub.uni-bielefeld.de/scs/co ``` #### Run -You can now use the environment and/or simulator in your python code. Just by importing it `import overcooked-environment` +You can now use the environment and/or simulator in your python code. Just by importing it `import overcooked_environment` ## Configuration The environment configuration is currently done with 3 config files + GUI configuration. -- GitLab