From 49b9886f4b60c2c43267f3a9b4203905a01359bc Mon Sep 17 00:00:00 2001 From: Ostrzyciel Date: Mon, 22 Apr 2024 11:52:53 +0200 Subject: [PATCH 1/2] Improve README a bit - Fix heading levels to be more consistent. - Add a short section about contributing and reporting issues. --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7608f2b..d052337 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,10 @@ Tools in this repository were used to create the **[SC2ReSet: StarCraft II Esport Replaypack Set](https://doi.org/10.5281/zenodo.5575796)**, and finally **[SC2EGSet: StarCraft II Esport Game State Dataset](https://doi.org/10.5281/zenodo.5503997)**. -# Installation +## Installation To install current version of the toolset as separate CLI tools run the following command: + ``` pip install datasetpreparator[all] ``` @@ -41,9 +42,15 @@ In order to specify different processing flags for https://github.com/Kaszanas/S Each of the scripts has its usage described in their respective `README.md` files. -# Citations +## Contributing and Reporting Issues + +If you want to report a bug, request a feature, or open any other issue, please do so in the **[issue tracker](https://github.com/Kaszanas/SC2DatasetPreparator/issues/new/choose)**. + +Please see **[CONTRIBUTING.md](https://github.com/Kaszanas/SC2DatasetPreparator/blob/main/CONTRIBUTING.md)** for detailed development instructions and contribution guidelines. + +## Citing -## This Repository +### This Repository ``` @software{Białecki_2022_6366039, @@ -62,7 +69,7 @@ Each of the scripts has its usage described in their respective `README.md` file ``` -## [SC2EGSet: Dataset Description](https://arxiv.org/abs/2207.03428) +### [SC2EGSet: Dataset Description](https://arxiv.org/abs/2207.03428) ``` @article{Białecki2023, From b815654fe13700e58702c400548098ff093aced2 Mon Sep 17 00:00:00 2001 From: Kaszanas <34846245+Kaszanas@users.noreply.github.com> Date: Mon, 22 Apr 2024 23:11:28 +0200 Subject: [PATCH 2/2] docs: changed article url, better tex key --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d052337..ce00d30 100644 --- a/README.md +++ b/README.md @@ -69,10 +69,10 @@ Please see **[CONTRIBUTING.md](https://github.com/Kaszanas/SC2DatasetPreparator/ ``` -### [SC2EGSet: Dataset Description](https://arxiv.org/abs/2207.03428) +### [SC2EGSet: Dataset Description](https://www.researchgate.net/publication/373767449_SC2EGSet_StarCraft_II_Esport_Replay_and_Game-state_Dataset) ``` -@article{Białecki2023, +@article{Bialecki2023_SC2EGSet, author = {Bia{\l}ecki, Andrzej and Jakubowska, Natalia and Dobrowolski, Pawe{\l}