Upload README.md with huggingface_hub

README.md

@@ -1,3 +1,4 @@
+````
 ---
 language: en
 license: apache-2.0
@@ -36,6 +37,22 @@ Code accompanying the paper
 [[paper](https://arxiv.org/abs/2302.07515)]  [[videos](https://www.youtube.com/watch?v=U9REh0otmVU)]  [[code](https://github.com/OpenRL-Lab/TiZero)]
 
 
+### Installation
+
+- Follow the instructions in [gfootball](https://github.com/google-research/football#on-your-computer) to set up the environment.
+- `pip install gfootball`
+- `pip install tizero` (or clone this repo and `pip install -e .`).
+- test the installation by `python3 -m gfootball.play_game --action_set=full`.
+
+### Convert dump file to video
+
+After the installation, you can use tizero to convert a dump file to a video file.
+The usage is `tizero dump2video <dump_file> <output_dir> --episode_length <the length> --render_type <2d/3d>`.
+
+You can download an example dump file from [here](http://jidiai.cn/daily_6484285/daily_6484285.dump). 
+And then execute `tizero dump2video daily_6484285.dump ./` in your terminal. By default, the episode length is 3000 and the render type is 2d.
+Wait a minute, you will get a video file named `daily_6484285.avi` in your current directory.
+
 ### Submit TiZero to JIDI(及第评测平台)
 
 JIDI is a public evaluation platform for RL agents. You can submit your agent of GRF at: [http://www.jidiai.cn/env_detail?envid=34](http://www.jidiai.cn/env_detail?envid=34).
@@ -54,4 +71,5 @@ Please cite our paper if you use our codes or our weights in your own work:
   journal={arXiv preprint arXiv:2302.07515},
   year={2023}
 }
-```
+```
+````