Skip to content

Commit

Permalink
Merge pull request #1 from ThalesGroup/dev
Browse files Browse the repository at this point in the history
docs: fix doc on demo
  • Loading branch information
iv-stoyanova committed Jul 11, 2024
2 parents 21782be + cdba586 commit b46b569
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,11 @@ pip install openthechests
The environment is then ready to execute by simply running the `demo.py` file.

## Running the Demo
The execution of the demo file generates an environment using a `YAML` configuration
To test the environment, download the `docs` and `demo.py` folders.
The `docs` folder contains examples of usage of the environment that are representative of its functioning as well as an example configuration for the demonstration.
The execution of the `demo.py` file generates an environment using a `YAML` configuration
file and allows you to interact with the environment manually.
To run the demo, use the following command:
To run the demonstration, use the following command:
```shell
python demo.py
```
Expand Down

0 comments on commit b46b569

Please sign in to comment.