Skip to content
Snippets Groups Projects
Commit eb4ae7eb authored by Florian Schröder's avatar Florian Schröder
Browse files

Update documentation and improve changelog

The provided modifications involve an update to the .gitlab-ci.yml file to include a footer text in the project documentation. There's also an additional point added to the CHANGELOG.md file under the 'study participants' section for clarity. Furthermore, the README.md has been slightly restructured to explicitly mention the availability of extensive project details in the documentation.
parent 593f63c1
No related branches found
No related tags found
No related merge requests found
Pipeline #47813 passed
...@@ -18,7 +18,7 @@ pages: ...@@ -18,7 +18,7 @@ pages:
- apt-get install -y python3-dev python3-pip graphviz graphviz-dev - apt-get install -y python3-dev python3-pip graphviz graphviz-dev
- pip install pdoc - pip install pdoc
- pip install ".[rl]" - pip install ".[rl]"
- pdoc --output-dir public cooperative_cuisine !cooperative_cuisine.reinforcement_learning --logo https://gitlab.ub.uni-bielefeld.de/uploads/-/system/project/avatar/6780/Cooking-Vector-Illustration-Icon-Graphics-4267218-1-580x435.jpg --docformat google --favicon overcooked-simulator/cooperative_cuisine/pygame_2d_vis/images/favicon.ico footer-text "Developed@[SCS](https://scs.techfak.uni-bielefeld.de/)" - pdoc --output-dir public cooperative_cuisine !cooperative_cuisine.reinforcement_learning --logo https://gitlab.ub.uni-bielefeld.de/uploads/-/system/project/avatar/6780/Cooking-Vector-Illustration-Icon-Graphics-4267218-1-580x435.jpg --docformat google --favicon overcooked-simulator/cooperative_cuisine/pygame_2d_vis/images/favicon.ico --footer-text "Developed@[SCS](https://scs.techfak.uni-bielefeld.de/)"
artifacts: artifacts:
paths: paths:
- public - public
......
...@@ -41,6 +41,7 @@ study server, 2D visualization, etc. ...@@ -41,6 +41,7 @@ study server, 2D visualization, etc.
visualization, study visualization, study
- Game server that handles active environments - Game server that handles active environments
- Study environment with study server and study config. Does the match making - Study environment with study server and study config. Does the match making
- For study participants: simple control tutorial, recipe guides, end screen.
- Controller support - Controller support
### Security ### Security
......
...@@ -7,9 +7,11 @@ ...@@ -7,9 +7,11 @@
# Cooperative Cuisine Environment # Cooperative Cuisine Environment
[Documentation](https://scs.pages.ub.uni-bielefeld.de/cocosy/overcooked-simulator)
The overcooked-like cooperative cuisine environment for real-time human cooperative interactions and artificial agents. The overcooked-like cooperative cuisine environment for real-time human cooperative interactions and artificial agents.
For an extensive introduction, have a look at
the [Documentation](https://scs.pages.ub.uni-bielefeld.de/cocosy/overcooked-simulator).
<div align="center"> <div align="center">
<img src="cooperative_cuisine/pygame_2d_vis/images/cooperative_cuisine.png" width="800"> <img src="cooperative_cuisine/pygame_2d_vis/images/cooperative_cuisine.png" width="800">
</div> </div>
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment